BigCommerce · Schema

subscriber_Base

Common Subscriber properties.

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
email string The email of the subscriber. Must be unique.
first_name string The first name of the subscriber.
last_name string The last name of the subscriber.
source string The source of the subscriber. Values are: `storefront`, `order`, or `custom`.
order_id integer The ID of the source order, if source was an order.
channel_id integer The channel ID where the subscriber was created.
View JSON Schema on GitHub

JSON Schema

bigcommerce-subscriber-base-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/subscriber_Base",
  "title": "subscriber_Base",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The email of the subscriber. Must be unique.\n",
      "x-required": [
        "post"
      ]
    },
    "first_name": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "description": "The first name of the subscriber.\n"
    },
    "last_name": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "description": "The last name of the subscriber.\n"
    },
    "source": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "description": "The source of the subscriber. Values are: `storefront`, `order`, or `custom`.\n"
    },
    "order_id": {
      "maximum": 2147483647,
      "minimum": 1,
      "type": "integer",
      "description": "The ID of the source order, if source was an order.\n",
      "nullable": true
    },
    "channel_id": {
      "maximum": 2147483647,
      "minimum": 1,
      "type": "integer",
      "description": "The channel ID where the subscriber was created."
    }
  },
  "description": "Common Subscriber properties.",
  "x-internal": false
}