{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/PostCouponCodeResponse",
"title": "PostCouponCodeResponse",
"type": "object",
"properties": {
"data": {
"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": {
"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",
"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
},
"status": {
"description": "The current status of the coupon code.",
"type": "string",
"example": "UNASSIGNED",
"enum": [
"ASSIGNED_TO_PROFILE",
"DELETING",
"PROCESSING",
"UNASSIGNED",
"USED",
"VERSION_NOT_ACTIVE"
],
"nullable": true
}
}
},
"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"
]
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
},
"profile": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/ProfileEnum"
},
"id": {
"type": "string",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H"
}
},
"required": [
"type",
"id"
]
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
}
}
}
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"type",
"id",
"attributes",
"links"
]
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
]
}