AddPointsBody

  • points
    Type: integer
    min:  
    1
    required

    Integer numbers.

  • description
    Type: string

    Optional, general purpose text to describe or tag this point credit e.g. "Referral", "Legacy Loyalty Import", "Manual credit (STOREID:ABC123)" that will appear in the Loyalty Activity log.

  • expiration_days
    Type: integer

    This field may be provided instead of expires_at (both will result in an error). If set, points will expire this many days from the time of issuance, following program settings for expiration buffering, time, and time zone.

  • expires_at
    Type: stringFormat: date-time

    Optional RFC 3339 datetime after which these points will expire. Not setting expires_at will result in points not expiring.

  • point_balance
    Type: integer
    read-only

    Point balance after crediting the points.

Examples 
{
  "points": 1,
  "description": "string",
  "expires_at": "string",
  "expiration_days": "integer"
}