API Test Keys

Add-on Entity

The Add-ons entity has the following parameters.

Is this page helpful?

Entity

1
{
2
"entity":"collection",
3
"count":2,
4
"items":[
5
{
6
"id":"ao_00000000000002",
7
"entity":"addon",
8
"item":{
9
"id":"item_00000000000002",
10
"active":true,
11
"name":"Extra sweet",
12
"description":"1 extra sweet of the day with meals",
13
"amount":90000,
14
"unit_amount":90000,
15
"currency":"MYR",
16
"type":"addon",
17
"unit":null,
18
"tax_inclusive":false,
19
"hsn_code":null,
20
"sac_code":null,
21
"tax_rate":null,
22
"tax_id":null,
23
"tax_group_id":null,
24
"created_at":1581597318,
25
"updated_at":1581597318
26
},
27
"quantity":1,
28
"created_at":1581597318,
29
"subscription_id":"sub_00000000000001",
30
"invoice_id":"inv_00000000000001"
31
},
32
{
33
"id":"ao_00000000000001",
34
"entity":"addon",
35
"item":{
36
"id":"item_00000000000001",
37
"active":true,
38
"name":"Extra muffin",
39
"description":"extra muffin with meals",
40
"amount":30000,
41
"unit_amount":30000,
42
"currency":"MYR",
43
"type":"addon",
44
"unit":null,
45
"tax_inclusive":false,
46
"hsn_code":null,
47
"sac_code":null,
48
"tax_rate":null,
49
"tax_id":null,
50
"tax_group_id":null,
51
"created_at":1581597318,
52
"updated_at":1581597318
53
},
54
"quantity":2,
55
"created_at":1581597318,
56
"subscription_id":"sub_00000000000001",
57
"invoice_id":null
58
}
59
]
60
}
id
string

The unique identifier of the created add-on. For example, ao_00000000000001.

item
object

Details of the created add-on.

Show child parameters (7)

quantity
integer

This specifies the number of units of the add-on to be charged to the customer. For example, 2. The total amount is calculated as amount * quantity.

created_at
integer

The Unix timestamp, indicates when the add-on was created. For example, 1581597318.

subscription_id
string

The unique identifier of the Subscription to which the add-on is being added. For example, sub_00000000000001.

invoice_id
string

The add-on is added to the next invoice that is generated after it is created. This field is populated only after the invoice is generated. Until then, it is null. Once the add-on is linked to an invoice, it cannot be deleted.

Add-on Entity

The Add-ons entity has the following parameters.

Is this page helpful?

id
string

The unique identifier of the created add-on. For example, ao_00000000000001.

item
object

Details of the created add-on.

Show child parameters (7)

quantity
integer

This specifies the number of units of the add-on to be charged to the customer. For example, 2. The total amount is calculated as amount * quantity.

created_at
integer

The Unix timestamp, indicates when the add-on was created. For example, 1581597318.

subscription_id
string

The unique identifier of the Subscription to which the add-on is being added. For example, sub_00000000000001.

invoice_id
string

The add-on is added to the next invoice that is generated after it is created. This field is populated only after the invoice is generated. Until then, it is null. Once the add-on is linked to an invoice, it cannot be deleted.

Entity

1
{
2
"entity":"collection",
3
"count":2,
4
"items":[
5
{
6
"id":"ao_00000000000002",
7
"entity":"addon",
8
"item":{
9
"id":"item_00000000000002",
10
"active":true,
11
"name":"Extra sweet",
12
"description":"1 extra sweet of the day with meals",
13
"amount":90000,
14
"unit_amount":90000,
15
"currency":"MYR",
16
"type":"addon",
17
"unit":null,
18
"tax_inclusive":false,
19
"hsn_code":null,
20
"sac_code":null,
21
"tax_rate":null,
22
"tax_id":null,
23
"tax_group_id":null,
24
"created_at":1581597318,
25
"updated_at":1581597318
26
},
27
"quantity":1,
28
"created_at":1581597318,
29
"subscription_id":"sub_00000000000001",
30
"invoice_id":"inv_00000000000001"
31
},
32
{
33
"id":"ao_00000000000001",
34
"entity":"addon",
35
"item":{
36
"id":"item_00000000000001",
37
"active":true,
38
"name":"Extra muffin",
39
"description":"extra muffin with meals",
40
"amount":30000,
41
"unit_amount":30000,
42
"currency":"MYR",
43
"type":"addon",
44
"unit":null,
45
"tax_inclusive":false,
46
"hsn_code":null,
47
"sac_code":null,
48
"tax_rate":null,
49
"tax_id":null,
50
"tax_group_id":null,
51
"created_at":1581597318,
52
"updated_at":1581597318
53
},
54
"quantity":2,
55
"created_at":1581597318,
56
"subscription_id":"sub_00000000000001",
57
"invoice_id":null
58
}
59
]
60
}