Klaviyo · Schema

CouponCodeUpdateQueryResourceObject

MarketingEmailSMSCustomer DataEcommerceAutomation

Properties

Name Type Description
type object
id string The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.
attributes object
View JSON Schema on GitHub

JSON Schema

klaviyo-couponcodeupdatequeryresourceobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CouponCodeUpdateQueryResourceObject",
  "title": "CouponCodeUpdateQueryResourceObject",
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/CouponCodeEnum"
    },
    "id": {
      "description": "The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.",
      "type": "string",
      "example": "10OFF-ASD325FHK324UJDOI2M3JNES99"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "status": {
          "description": "The API status of our coupon codes.",
          "type": "string",
          "enum": [
            "ASSIGNED_TO_PROFILE",
            "DELETING",
            "PROCESSING",
            "UNASSIGNED",
            "USED",
            "VERSION_NOT_ACTIVE"
          ],
          "nullable": true
        },
        "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": [
    "type",
    "id",
    "attributes"
  ]
}