Skip to content

Event Overview - Payload - Entity - Share

Target Audience: Users, Developers, Stakeholders

Introduction

This document defines the entity share for an event payload.

Description

The share entity in the payload object.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{
    "share": {
      "id": "60df032c09c04c493db41376",
      "organisation_id": "organisation",
      "sharer": {},
      "receiver": {},
      "user_product": {
        "id": "60df032c09c04c493db41379",
        "order_id": "60df032c09c04c493db4137f",
        "product_id": "60df032c09c04c493db4136f",
        "product_title_code": "TITLE_CODE",
        "product_title_name": "TITLE",
        "code": "package_code",
        "name": "product_name",
        "description": "short_description <a href=\"http://www.google.com\">Foo</a>",
        "campaign": false,
        "valid_from": "2021-07-01T14:14:36+02:00",
        "valid_to": "2021-07-03T14:14:36+02:00",
        "state": "activated",
        "is_recurring": false,
        "cancellation_date": "",
        "cancellation_reason": "",
        "grace_period_to": "",
        "created": "2021-07-02T14:14:36+02:00",
        "updated": "2021-07-02T14:14:36+02:00",
        "provision_service": "tulo",
        "merchant_reference": null
      },
      "state": null,
      "invite": {},
      "created": "2021-07-02T14:14:36+02:00",
      "updated": "2021-07-02T14:14:36+02:00"
    }
}