BigCommerce · Schema
Gift Certificate
A gift-certificate model.
E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS
Properties
| Name | Type | Description |
|---|---|---|
| code | string | The gift-certificate code. |
| original_balance | number | The balance on a gift certificate when it was purchased. |
| starting_balance | number | The balance on a gift certificate at the time of this purchase. |
| remaining_balance | number | The remaining balance on a gift certificate. |
| status | string | The status of a gift certificate: `active` - gift certificate is active; `pending` - gift certificate purchase is pending; `disabled` - gift certificate is disabled; `expired` - gift certificate is ex |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/GiftCertificate",
"title": "Gift Certificate",
"type": "object",
"description": "A gift-certificate model.",
"x-internal": false,
"properties": {
"code": {
"description": "The gift-certificate code.\n",
"type": "string",
"example": "MB345"
},
"original_balance": {
"type": "number",
"description": "The balance on a gift certificate when it was purchased.\n",
"format": "float",
"example": 100,
"minimum": 0,
"maximum": 21474836.47
},
"starting_balance": {
"type": "number",
"description": "The balance on a gift certificate at the time of this purchase.\n",
"format": "float",
"example": 100,
"minimum": 0
},
"remaining_balance": {
"description": "The remaining balance on a gift certificate.\n",
"type": "number",
"format": "float",
"example": 35.42
},
"status": {
"description": "The status of a gift certificate: `active` - gift certificate is active; `pending` - gift certificate purchase is pending; `disabled` - gift certificate is disabled; `expired` - gift certificate is expired.\n",
"type": "string",
"enum": [
"active",
"pending",
"disabled",
"expired"
]
}
}
}