Klaviyo · Schema

CouponCodeCreateQueryResourceObject

MarketingEmailSMSCustomer DataEcommerceAutomation

Properties

Name Type Description
type object
attributes object
relationships object
View JSON Schema on GitHub

JSON Schema

klaviyo-couponcodecreatequeryresourceobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CouponCodeCreateQueryResourceObject",
  "title": "CouponCodeCreateQueryResourceObject",
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/CouponCodeEnum"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "unique_code": {
          "description": "This is a unique string that will be or is assigned to each customer/profile and is associated with a coupon.",
          "type": "string",
          "example": "ASD325FHK324UJDOI2M3JNES99"
        },
        "expires_at": {
          "description": "The datetime when this coupon code will expire. If not specified or set to null, it will be automatically set to 1 year.",
          "type": "string",
          "format": "date-time",
          "example": "2022-11-08T00:00:00+00:00",
          "nullable": true
        }
      },
      "required": [
        "unique_code"
      ]
    },
    "relationships": {
      "type": "object",
      "properties": {
        "coupon": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "type": {
                  "$ref": "#/components/schemas/CouponEnum"
                },
                "id": {
                  "type": "string",
                  "example": "10OFF"
                }
              },
              "required": [
                "type",
                "id"
              ]
            }
          }
        }
      },
      "required": [
        "coupon"
      ]
    }
  },
  "required": [
    "type",
    "attributes",
    "relationships"
  ]
}