|
4 | 4 | "type": "object",
|
5 | 5 | "properties": {
|
6 | 6 | "id": {
|
| 7 | + "description": "Unique identifier for the addon.", |
7 | 8 | "type": ["string", "null"]
|
8 | 9 | },
|
9 | 10 | "name": {
|
| 11 | + "description": "Name of the addon.", |
10 | 12 | "type": ["string", "null"]
|
11 | 13 | },
|
12 | 14 | "invoice_name": {
|
| 15 | + "description": "Name to be displayed on the invoice for the addon.", |
13 | 16 | "type": ["string", "null"]
|
14 | 17 | },
|
15 | 18 | "description": {
|
| 19 | + "description": "Description of the addon.", |
16 | 20 | "type": ["string", "null"]
|
17 | 21 | },
|
18 | 22 | "pricing_model": {
|
| 23 | + "description": "Model used for pricing the addon.", |
19 | 24 | "type": ["string", "null"]
|
20 | 25 | },
|
21 | 26 | "charge_type": {
|
| 27 | + "description": "Type of charge for the addon.", |
22 | 28 | "type": ["string", "null"]
|
23 | 29 | },
|
24 | 30 | "price": {
|
| 31 | + "description": "Price of the addon.", |
25 | 32 | "type": ["integer", "null"]
|
26 | 33 | },
|
27 | 34 | "currency_code": {
|
| 35 | + "description": "Currency code for the addon pricing.", |
28 | 36 | "type": ["string", "null"]
|
29 | 37 | },
|
30 | 38 | "period": {
|
| 39 | + "description": "Duration of the addon period.", |
31 | 40 | "type": ["integer", "null"]
|
32 | 41 | },
|
33 | 42 | "period_unit": {
|
| 43 | + "description": "Unit of duration for the addon period.", |
34 | 44 | "type": ["string", "null"]
|
35 | 45 | },
|
36 | 46 | "unit": {
|
| 47 | + "description": "Unit of the addon quantity.", |
37 | 48 | "type": ["string", "null"]
|
38 | 49 | },
|
39 | 50 | "status": {
|
| 51 | + "description": "Status of the addon.", |
40 | 52 | "type": ["string", "null"]
|
41 | 53 | },
|
42 | 54 | "archived_at": {
|
| 55 | + "description": "Timestamp indicating when the addon was archived.", |
43 | 56 | "type": ["integer", "null"]
|
44 | 57 | },
|
45 | 58 | "enabled_in_portal": {
|
| 59 | + "description": "Indicator for whether the addon is enabled in the customer portal.", |
46 | 60 | "type": ["boolean", "null"]
|
47 | 61 | },
|
48 | 62 | "tax_code": {
|
| 63 | + "description": "Tax code associated with the addon.", |
49 | 64 | "type": ["string", "null"]
|
50 | 65 | },
|
51 | 66 | "taxjar_product_code": {
|
| 67 | + "description": "TaxJar product code for tax calculation.", |
52 | 68 | "type": ["string", "null"]
|
53 | 69 | },
|
54 | 70 | "avalara_sale_type": {
|
| 71 | + "description": "Avalara sale type for tax calculation.", |
55 | 72 | "type": ["string", "null"]
|
56 | 73 | },
|
57 | 74 | "avalara_transaction_type": {
|
| 75 | + "description": "Avalara transaction type for tax calculation.", |
58 | 76 | "type": ["integer", "null"]
|
59 | 77 | },
|
60 | 78 | "avalara_service_type": {
|
| 79 | + "description": "Avalara service type for tax calculation.", |
61 | 80 | "type": ["integer", "null"]
|
62 | 81 | },
|
63 | 82 | "sku": {
|
| 83 | + "description": "Stock Keeping Unit (SKU) for the addon.", |
64 | 84 | "type": ["string", "null"]
|
65 | 85 | },
|
66 | 86 | "accounting_code": {
|
| 87 | + "description": "Accounting code for the addon.", |
67 | 88 | "type": ["string", "null"]
|
68 | 89 | },
|
69 | 90 | "accounting_category1": {
|
| 91 | + "description": "First accounting category for the addon.", |
70 | 92 | "type": ["string", "null"]
|
71 | 93 | },
|
72 | 94 | "accounting_category2": {
|
| 95 | + "description": "Second accounting category for the addon.", |
73 | 96 | "type": ["string", "null"]
|
74 | 97 | },
|
75 | 98 | "accounting_category3": {
|
| 99 | + "description": "Third accounting category for the addon.", |
76 | 100 | "type": ["string", "null"]
|
77 | 101 | },
|
78 | 102 | "accounting_category4": {
|
| 103 | + "description": "Fourth accounting category for the addon.", |
79 | 104 | "type": ["string", "null"]
|
80 | 105 | },
|
81 | 106 | "is_shippable": {
|
| 107 | + "description": "Indicator for whether the addon is shippable.", |
82 | 108 | "type": ["boolean", "null"]
|
83 | 109 | },
|
84 | 110 | "shipping_frequency_period": {
|
| 111 | + "description": "Frequency of shipping for the addon period.", |
85 | 112 | "type": ["integer", "null"]
|
86 | 113 | },
|
87 | 114 | "shipping_frequency_period_unit": {
|
| 115 | + "description": "Unit of frequency for shipping the addon.", |
88 | 116 | "type": ["string", "null"]
|
89 | 117 | },
|
90 | 118 | "resource_version": {
|
| 119 | + "description": "Version of the resource.", |
91 | 120 | "type": ["integer", "null"]
|
92 | 121 | },
|
93 | 122 | "updated_at": {
|
| 123 | + "description": "Timestamp of the last update to the addon data.", |
94 | 124 | "type": ["integer", "null"]
|
95 | 125 | },
|
96 | 126 | "price_in_decimal": {
|
| 127 | + "description": "Price of the addon in decimal format.", |
97 | 128 | "type": ["string", "null"]
|
98 | 129 | },
|
99 | 130 | "included_in_mrr": {
|
| 131 | + "description": "Indicator for whether the addon is included in Monthly Recurring Revenue (MRR).", |
100 | 132 | "type": ["boolean", "null"]
|
101 | 133 | },
|
102 | 134 | "invoice_notes": {
|
| 135 | + "description": "Additional notes to include on the invoice for the addon.", |
103 | 136 | "type": ["string", "null"]
|
104 | 137 | },
|
105 | 138 | "taxable": {
|
| 139 | + "description": "Indicator for whether the addon is taxable.", |
106 | 140 | "type": ["boolean", "null"]
|
107 | 141 | },
|
108 | 142 | "tax_profile_id": {
|
| 143 | + "description": "Tax profile identifier for the addon.", |
109 | 144 | "type": ["string", "null"]
|
110 | 145 | },
|
111 | 146 | "meta_data": {
|
| 147 | + "description": "Additional metadata associated with the addon.", |
112 | 148 | "type": ["object", "null"],
|
113 | 149 | "properties": {}
|
114 | 150 | },
|
115 | 151 | "show_description_in_invoices": {
|
| 152 | + "description": "Indicator for whether the description should appear on invoices.", |
116 | 153 | "type": ["boolean", "null"]
|
117 | 154 | },
|
118 | 155 | "show_description_in_quotes": {
|
| 156 | + "description": "Indicator for whether the description should appear on quotes.", |
119 | 157 | "type": ["boolean", "null"]
|
120 | 158 | },
|
121 | 159 | "channel": {
|
| 160 | + "description": "Channel for which the addon is applicable.", |
122 | 161 | "type": ["string", "null"]
|
123 | 162 | },
|
124 | 163 | "object": {
|
| 164 | + "description": "Type of object, in this case, addon.", |
125 | 165 | "type": ["string", "null"]
|
126 | 166 | },
|
127 | 167 | "type": {
|
| 168 | + "description": "Type of addon.", |
128 | 169 | "type": ["string", "null"]
|
129 | 170 | },
|
130 | 171 | "tiers": {
|
| 172 | + "description": "Tiers with specific pricing for the addon.", |
131 | 173 | "type": ["array", "null"],
|
132 | 174 | "items": {
|
133 | 175 | "type": ["object", "null"],
|
134 | 176 | "properties": {
|
135 | 177 | "starting_unit": {
|
| 178 | + "description": "Starting unit quantity for the tier.", |
136 | 179 | "type": ["integer", "null"]
|
137 | 180 | },
|
138 | 181 | "ending_unit": {
|
| 182 | + "description": "Ending unit quantity for the tier.", |
139 | 183 | "type": ["integer", "null"]
|
140 | 184 | },
|
141 | 185 | "price": {
|
| 186 | + "description": "Price of the tier.", |
142 | 187 | "type": ["integer", "null"]
|
143 | 188 | },
|
144 | 189 | "starting_unit_in_decimal": {
|
| 190 | + "description": "Starting unit quantity in decimal for the tier.", |
145 | 191 | "type": ["string", "null"]
|
146 | 192 | },
|
147 | 193 | "ending_unit_in_decimal": {
|
| 194 | + "description": "Ending unit quantity in decimal for the tier.", |
148 | 195 | "type": ["string", "null"]
|
149 | 196 | },
|
150 | 197 | "price_in_decimal": {
|
| 198 | + "description": "Price of the tier in decimal format.", |
151 | 199 | "type": ["string", "null"]
|
152 | 200 | }
|
153 | 201 | }
|
154 | 202 | }
|
155 | 203 | },
|
156 | 204 | "custom_fields": {
|
| 205 | + "description": "Custom fields associated with the addon.", |
157 | 206 | "$ref": "_definitions.json#/definitions/custom_fields"
|
158 | 207 | }
|
159 | 208 | }
|
|
0 commit comments