loyalty program created

EVENT

loyalty.program.created

Published when a loyalty program is created.

Permissions:LOYALTY_READ

Link to section

Event payload

Example code

Link to section

merchant_id

string

The ID of the Square seller associated with the event.

Link to section

type

string

The type of event. For this event, the value is loyalty.program.created.

Link to section

event_id

string

The unique ID for the event, which is used for idempotency support.

Link to section

created_at

string

Read only The timestamp of when the event was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

data

The data associated with the event.

Link to section

Examples

Response JSON

{
  "merchant_id": "C337NFWQT2A6W",
  "type": "loyalty.program.created",
  "event_id": "b10404b2-08c4-4c66-9299-c11feceb43dd",
  "created_at": "2020-05-13T01:38:42.785Z",
  "data": {
    "type": "loyalty_program",
    "id": "5216e8b2-d43e-41e2-9ed8-eccf3e892aef",
    "object": {
      "loyalty_program": {
        "id": "5216e8b2-d43e-41e2-9ed8-eccf3e892aef",
        "location_ids": [
          "2Z3BMKQB939X0"
        ],
        "status": "ACTIVE",
        "terminology": {
          "one": "Point",
          "other": "Points"
        },
        "accrual_rules": [
          {
            "accrual_type": "SPEND",
            "points": 1,
            "spend_data": {
              "amount_money": {
                "amount": 100,
                "currency": "USD"
              },
              "tax_mode": "BEFORE_TAX"
            }
          }
        ],
        "reward_tiers": [
          {
            "id": "927cab58-09cd-410f-aa68-a44015d8bbbb",
            "name": "5% off entire sale",
            "points": 5,
            "definition": {
              "discount_type": "FIXED_PERCENTAGE",
              "percentage_discount": "5",
              "scope": "ORDER"
            },
            "created_at": "2019-08-19T18:22:45Z",
            "pricing_rule_reference": {
              "object_id": "ZKFKBH5IINTZLY3VA2OWIFX3",
              "catalog_version": "1603960067138"
            }
          },
          {
            "id": "aa5373ef-191d-4cb5-b122-8e8de41ab32f",
            "name": "20% off entire sale",
            "points": 15,
            "definition": {
              "discount_type": "FIXED_PERCENTAGE",
              "percentage_discount": "20",
              "scope": "ORDER"
            },
            "created_at": "2020-05-13T01:38:40Z",
            "pricing_rule_reference": {
              "object_id": "74C4JSHESNLTB2A7ITO5HO6F",
              "catalog_version": "1605486402527"
            }
          }
        ],
        "created_at": "2019-08-19T18:22:46Z",
        "updated_at": "2020-05-13T01:38:40Z"
      }
    }
  }
}