Schemathesis 4.32.1
API Coverage Report
2026-10-19 19:59:37
Operations
Operations called at least once
96.9% 222 of 229 called
Parameters
Tested with valid and invalid values
59.4% 303 of 510 covered
Keywords
Constraints tested both ways
84.1% 4600 of 5465 covered
Examples
Schema examples sent in tests
82.3% 284 of 345 used
Responses
Documented response codes hit
64.6% 398 of 616 received
Show
accounts 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100% #
Body
application/json10 / 10
AccountCreateForOrganization
#validinvalidschema
140751{
241240 "properties": {
343316 "account_type": {
443316 "const": "stripe",
54445 "type": "string"
643316 },
743118 "country": {
943118 },
104456 "organization_id": {
114451 "format": "uuid",
124465 "type": "string"
134456 }
1441240 },
154475 "required": [
164511 "organization_id",
174493 "account_type",
184493 "country"
194475 ],
204526 "type": "object"
2140751}
Referenced Components (1)3 of 3 keywords
StripeAccountCountry3 of 3 keywords
143118{
243118 "enum": [
321n/a "AL",
413n/a "AG",
50n/a "AR",
64n/a "AM",
79n/a "AU",
81n/a "AT",
96n/a "BH",
102n/a "BE",
110n/a "BO",
126n/a "BA",
130n/a "BG",
143n/a "KH",
150n/a "CA",
162n/a "CL",
172n/a "CO",
183n/a "CR",
191n/a "HR",
206n/a "CY",
211n/a "CZ",
222n/a "CI",
230n/a "DK",
242n/a "DO",
253n/a "EC",
261n/a "EG",
271n/a "SV",
280n/a "EE",
291n/a "ET",
304n/a "FI",
313n/a "FR",
320n/a "GM",
331n/a "DE",
340n/a "GH",
352n/a "GR",
361n/a "GT",
370n/a "GY",
380n/a "HK",
390n/a "HU",
400n/a "IS",
414n/a "IN",
422n/a "ID",
433n/a "IE",
441n/a "IL",
454n/a "IT",
461n/a "JM",
472n/a "JP",
484n/a "JO",
494n/a "KE",
501n/a "KW",
511n/a "LV",
522n/a "LI",
531n/a "LT",
541n/a "LU",
552n/a "MO",
565n/a "MG",
573n/a "MY",
581n/a "MT",
592n/a "MU",
601n/a "MX",
611n/a "MD",
623n/a "MN",
635n/a "MA",
645n/a "NA",
652n/a "NL",
664n/a "NZ",
671n/a "NG",
681n/a "MK",
692n/a "NO",
703n/a "OM",
717n/a "PA",
722n/a "PY",
733n/a "PE",
745n/a "PH",
751n/a "PL",
761n/a "PT",
771n/a "QA",
782n/a "RO",
791n/a "RW",
803n/a "SA",
818n/a "SN",
821n/a "RS",
8310n/a "SG",
842n/a "SK",
853n/a "SI",
862n/a "ZA",
873n/a "KR",
883n/a "ES",
892n/a "LK",
902n/a "LC",
912n/a "SE",
922n/a "CH",
934n/a "TZ",
941n/a "TH",
951n/a "TT",
962n/a "TN",
972n/a "TR",
98130n/a "AE",
995n/a "GB",
1001n/a "US",
1012n/a "UY",
1023n/a "UZ",
1031n/a "VN",
1043n/a "DZ",
1053n/a "AO",
1062n/a "AZ",
1071n/a "BS",
1082n/a "BD",
1091n/a "BJ",
1101n/a "BT",
1112n/a "BW",
1121n/a "BN",
1131n/a "GA",
1148n/a "KZ",
1152n/a "LA",
1161n/a "MC",
1177n/a "MZ",
1182n/a "NE",
1191n/a "PK",
1201n/a "SM",
1211n/a "TW"
12243118 ],
1234445 "type": "string"
12443118}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error1075ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error34864ms
400Bad Request574ms
401Unauthorized643ms
Path Parameters
id2 / 2
#validinvalidschema
136459{
236459 "format": "uuid",
3423n/a "type": "string"
436459}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error595ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3397ms
401Unauthorized252ms
Path Parameters
id2 / 2
#validinvalidschema
171024{
271024 "format": "uuid",
3734n/a "type": "string"
471024}
Body
application/json34 / 34
AccountUpdate
141579{
233170 "properties": {
33634 "billing_additional_info": {
43634 "anyOf": [
520347 {
620347 "type": "string"
720347 },
834324 {
934324 "type": "null"
1034324 }
113634 ],
123634 },
1331658 "billing_address": {
1431658 "anyOf": [
1527995 {
1727995 },
1837337 {
1937337 "type": "null"
2037337 }
2131658 ],
2231658 },
233527 "billing_name": {
243527 "anyOf": [
2534325 {
2634325 "type": "string"
2734325 },
2831841 {
2931841 "type": "null"
3031841 }
313527 ],
323527 },
333605 "billing_notes": {
343605 "anyOf": [
3516349 {
3616349 "type": "string"
3716349 },
3834421 {
3934421 "type": "null"
4034421 }
413605 ],
423605 }
4333170 },
444859 "type": "object"
4541579}
Referenced Components (1)28 of 28 keywords
AddressInput28 of 28 keywords
127995{
228051 "properties": {
330218 "city": {
430218 "anyOf": [
511309 {
611309 "type": "string"
711309 },
829129 {
929129 "type": "null"
1029129 }
1130218 ],
1230218 },
133228 "country": {
143228 "enum": [
155n/a "AD",
165n/a "AE",
171n/a "AF",
181n/a "AG",
191n/a "AI",
201n/a "AL",
211n/a "AM",
221n/a "AO",
231n/a "AQ",
241n/a "AR",
251n/a "AS",
261n/a "AT",
271n/a "AU",
281n/a "AW",
291n/a "AX",
301n/a "AZ",
311n/a "BA",
321n/a "BB",
331n/a "BD",
348n/a "BE",
351n/a "BF",
361n/a "BG",
371n/a "BH",
381n/a "BI",
391n/a "BJ",
401n/a "BL",
411n/a "BM",
421n/a "BN",
431n/a "BO",
441n/a "BQ",
451n/a "BR",
461n/a "BS",
471n/a "BT",
481n/a "BV",
491n/a "BW",
501n/a "BY",
511n/a "BZ",
521n/a "CA",
531n/a "CC",
541n/a "CD",
551n/a "CF",
561n/a "CG",
571n/a "CH",
583n/a "CI",
591n/a "CK",
601n/a "CL",
611n/a "CM",
621n/a "CN",
631n/a "CO",
641n/a "CR",
651n/a "CV",
661n/a "CW",
671n/a "CX",
681n/a "CY",
691n/a "CZ",
701n/a "DE",
711n/a "DJ",
721n/a "DK",
731n/a "DM",
741n/a "DO",
751n/a "DZ",
761n/a "EC",
771n/a "EE",
781n/a "EG",
791n/a "EH",
801n/a "ER",
811n/a "ES",
821n/a "ET",
831n/a "FI",
842n/a "FJ",
851n/a "FK",
861n/a "FM",
871n/a "FO",
882n/a "FR",
891n/a "GA",
901n/a "GB",
911n/a "GD",
921n/a "GE",
931n/a "GF",
941n/a "GG",
951n/a "GH",
961n/a "GI",
971n/a "GL",
981n/a "GM",
991n/a "GN",
1001n/a "GP",
1013n/a "GQ",
1021n/a "GR",
1031n/a "GS",
1041n/a "GT",
1051n/a "GU",
1061n/a "GW",
1072n/a "GY",
1081n/a "HK",
1091n/a "HM",
1101n/a "HN",
1112n/a "HR",
1121n/a "HT",
1131n/a "HU",
1141n/a "ID",
1151n/a "IE",
1161n/a "IL",
1171n/a "IM",
1182n/a "IN",
1191n/a "IO",
1201n/a "IQ",
1211n/a "IS",
1221n/a "IT",
1231n/a "JE",
1241n/a "JM",
1251n/a "JO",
1261n/a "JP",
1271n/a "KE",
1281n/a "KG",
1291n/a "KH",
1301n/a "KI",
1311n/a "KM",
1321n/a "KN",
1331n/a "KR",
1342n/a "KW",
1351n/a "KY",
1361n/a "KZ",
1371n/a "LA",
1381n/a "LB",
1391n/a "LC",
1401n/a "LI",
1411n/a "LK",
1421n/a "LR",
1431n/a "LS",
1441n/a "LT",
1451n/a "LU",
1461n/a "LV",
1471n/a "LY",
1481n/a "MA",
1491n/a "MC",
1501n/a "MD",
1512n/a "ME",
1521n/a "MF",
1531n/a "MG",
1541n/a "MH",
1551n/a "MK",
1561n/a "ML",
1571n/a "MM",
1581n/a "MN",
1591n/a "MO",
1601n/a "MP",
1611n/a "MQ",
1621n/a "MR",
1631n/a "MS",
1641n/a "MT",
1651n/a "MU",
1661n/a "MV",
1671n/a "MW",
1681n/a "MX",
1691n/a "MY",
1701n/a "MZ",
1712n/a "NA",
1721n/a "NC",
1731n/a "NE",
1741n/a "NF",
1751n/a "NG",
1761n/a "NI",
1771n/a "NL",
1781n/a "NO",
1791n/a "NP",
1801n/a "NR",
1811n/a "NU",
1821n/a "NZ",
1831n/a "OM",
1844n/a "PA",
1851n/a "PE",
1861n/a "PF",
1871n/a "PG",
1881n/a "PH",
1892n/a "PK",
1901n/a "PL",
1911n/a "PM",
1921n/a "PN",
1931n/a "PR",
1941n/a "PS",
1951n/a "PT",
1961n/a "PW",
1971n/a "PY",
1981n/a "QA",
1991n/a "RE",
2001n/a "RO",
2011n/a "RS",
2024n/a "RW",
2031n/a "SA",
2041n/a "SB",
2051n/a "SC",
2061n/a "SD",
2074n/a "SE",
2081n/a "SG",
2091n/a "SH",
2101n/a "SI",
2111n/a "SJ",
2121n/a "SK",
2131n/a "SL",
2145n/a "SM",
2151n/a "SN",
2161n/a "SO",
2171n/a "SR",
2181n/a "SS",
2191n/a "ST",
2201n/a "SV",
2211n/a "SX",
2221n/a "SZ",
2231n/a "TC",
2241n/a "TD",
2251n/a "TF",
2261n/a "TG",
2271n/a "TH",
2281n/a "TJ",
2291n/a "TK",
2301n/a "TL",
2311n/a "TM",
2322n/a "TN",
2331n/a "TO",
2341n/a "TR",
2351n/a "TT",
2361n/a "TV",
2371n/a "TW",
2381n/a "TZ",
2391n/a "UA",
2401n/a "UG",
2411n/a "UM",
24236n/a "US",
2431n/a "UY",
2441n/a "UZ",
2451n/a "VA",
2461n/a "VC",
2471n/a "VE",
2481n/a "VG",
2491n/a "VI",
2501n/a "VN",
2511n/a "VU",
2521n/a "WF",
2531n/a "WS",
2541n/a "YE",
2551n/a "YT",
2562n/a "ZA",
2571n/a "ZM",
2581n/a "ZW"
2593228 ],
2603255 "type": "string",
2613228 },
26230012 "line1": {
26330012 "anyOf": [
26415297 {
26515297 "type": "string"
26615297 },
26728527 {
26828527 "type": "null"
26928527 }
27030012 ],
27130012 },
27229219 "line2": {
27329219 "anyOf": [
2747304 {
2757304 "type": "string"
2767304 },
27728526 {
27828526 "type": "null"
27928526 }
28029219 ],
28129219 },
28229912 "postal_code": {
28329912 "anyOf": [
28412299 {
28512299 "type": "string"
28612299 },
28728724 {
28828724 "type": "null"
28928724 }
29029912 ],
29129912 },
29229010 "state": {
29329010 "anyOf": [
2945295 {
2955295 "type": "string"
2965295 },
29728515 {
29828515 "type": "null"
29928515 }
30029010 ],
30129010 }
30228051 },
3033302 "required": [
3043302 "country"
3053302 ],
30633242 "type": "object"
30727995}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error1997ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3886ms
500Internal Server Error5776ms
400Bad Request1245ms
401Unauthorized182ms
Examples
Body: application/json
"US"AddressInput.country.examples[0]
"SE"AddressInput.country.examples[1]
"FR"AddressInput.country.examples[2]
Path Parameters
id2 / 2
#validinvalidschema
137071{
237071 "format": "uuid",
3441n/a "type": "string"
437071}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error7110ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3036ms
401Unauthorized672ms
Path Parameters
id2 / 2
#validinvalidschema
139940{
239940 "format": "uuid",
3439n/a "type": "string"
439940}
Query Parameters
return_path1 / 1
1438n/a{
2438n/a "type": "string"
3438n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error415ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3766ms
401Unauthorized222ms
auth 1 operation 0 covered 0 partial 1 uncovered 0 not measured — #
Expected Responses
codedescriptionhitsavg
200Successful Response0never seen
benefit-grants 1 operation 0 covered 1 partial 0 uncovered 0 not measured 55% #
Query Parameters
organization_id2 / 7
#validinvalidschema
16940{
26940 "anyOf": [
30694 {
400 "format": "uuid4",
50n/a "type": "string",
60694 },
76940 {
86940 "items": {
96940 "format": "uuid4",
10694n/a "type": "string",
116940 },
126940 "type": "array"
136940 },
140694 {
150694 "type": "null"
160694 }
176940 ],
186940}
customer_id4 / 7
1202119{
2202119 "anyOf": [
30321 {
400 "format": "uuid4",
50n/a "type": "string"
60321 },
7202119 {
8202119 "items": {
9863389 "format": "uuid4",
101252n/a "type": "string"
11202119 },
123210 "type": "array"
13202119 },
140321 {
150321 "type": "null"
160321 }
17202119 ],
18202119}
is_granted3 / 3
119337{
219337 "anyOf": [
313595 {
413595 "type": "boolean"
513595 },
658172 {
758172 "type": "null"
858172 }
919337 ],
1019337}
page2 / 2
127173{
227110 "exclusiveMinimum": 0,
328163 "type": "integer"
427173}
limit2 / 2
130658{
23068 "exclusiveMinimum": 0,
331450 "type": "integer"
430658}
sorting4 / 6
115090{
215090 "anyOf": [
315090 {
415090 "items": {
615090 },
72400 "type": "array"
815090 },
90240 {
100240 "type": "null"
110240 }
1215090 ],
1315090}
Referenced Components (1)3 of 3 keywords
BenefitGrantSortProperty3 of 3 keywords
1709733{
2709733 "enum": [
3168n/a "created_at",
4136n/a "-created_at",
599n/a "granted_at",
6130n/a "-granted_at",
791n/a "revoked_at",
885n/a "-revoked_at"
9709733 ],
101212n/a "type": "string"
11709733}
Responses
codedescriptionhitsavg
200Successful Response3748ms
422Validation Error2156ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1013ms
500Internal Server Error41858ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-created_at" ]sorting
benefits 6 operations 0 covered 6 partial 0 uncovered 0 not measured 89% #
Query Parameters
organization_id2 / 7
#validinvalidschema
16610{
26610 "anyOf": [
30661 {
400 "format": "uuid4",
50n/a "type": "string",
60661 },
76610 {
86610 "items": {
96610 "format": "uuid4",
10661n/a "type": "string",
116610 },
126610 "type": "array"
136610 },
140661 {
150661 "type": "null"
160661 }
176610 ],
186610}
type4 / 7
1220104{
2220104 "anyOf": [
30324 {
50324 },
6220104 {
7220104 "items": {
9220104 },
103240 "type": "array"
11220104 },
120324 {
130324 "type": "null"
140324 }
15220104 ],
16220104}
Referenced Components (1)3 of 3 keywords
BenefitType3 of 3 keywords
11053662{
21053662 "enum": [
3232n/a "custom",
4123n/a "discord",
5184n/a "github_repository",
6201n/a "downloadables",
7127n/a "license_keys",
8186n/a "meter_credit"
91053662 ],
101299n/a "type": "string"
111053662}
query3 / 3
1264n/a{
2264n/a "anyOf": [
3222n/a {
4222n/a "type": "string"
5222n/a },
642222 {
742222 "type": "null"
842222 }
9264n/a ],
10264n/a}
page2 / 2
132554{
232515 "exclusiveMinimum": 0,
334039 "type": "integer"
432554}
limit2 / 2
137233{
237214 "exclusiveMinimum": 0,
338619 "type": "integer"
437233}
sorting4 / 6
116775{
216775 "anyOf": [
316775 {
416775 "items": {
616775 },
72420 "type": "array"
816775 },
90242 {
100242 "type": "null"
110242 }
1216775 ],
1316775}
Referenced Components (1)3 of 3 keywords
BenefitSortProperty3 of 3 keywords
1678116{
2678116 "enum": [
3109n/a "created_at",
4120n/a "-created_at",
599n/a "description",
6107n/a "-description",
7125n/a "type",
8118n/a "-type"
9678116 ],
10730n/a "type": "string"
11678116}
metadata4 / 13
MetadataQuery
11750{
21750 "anyOf": [
31750 {
41750 "additionalProperties": {
55450 "anyOf": [
6388157 {
7388157 "type": "string"
8388157 },
90545 {
100545 "type": "integer"
110545 },
120545 {
130545 "type": "boolean"
140545 },
15157388 {
161570 "items": {
1715030 "type": "string"
181570 },
19157388 "type": "array"
20157388 },
210545 {
220157 "items": {
2301503 "type": "integer"
240157 },
25157388 "type": "array"
260545 },
270545 {
280157 "items": {
2901503 "type": "boolean"
300157 },
31157388 "type": "array"
320545 }
335450 ]
341750 },
351750 "type": "object"
361750 },
370175 {
380175 "type": "null"
390175 }
401750 ],
411750}
Responses
codedescriptionhitsavg
200Successful Response3418ms
422Validation Error1686ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1413ms
500Internal Server Error111825ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-created_at" ]sorting
Body
application/json203 / 219
BenefitCreate
#validinvalidschema
1595706{
2595706 "oneOf": [
31601141 {
51601141 },
6821219 {
8821219 },
9721229 {
11721229 },
12901211 {
14901211 },
151161185 {
171161185 },
18751226 {
20751226 }
21595706 ]
22595706}
Referenced Components (14)242 of 258 keywords
BenefitCustomCreate26 of 28 keywords
11601141{
21821109 "properties": {
3117685 "description": {
4118812 "maxLength": 42,
5118812 "minLength": 3,
6120061 "type": "string"
7117685 },
887190 "metadata": {
911829 "additionalProperties": {
1034637 "anyOf": [
11116267 {
121400 "maxLength": 500,
1311624 "minLength": 1,
14140243 "type": "string"
15116267 },
1686297 {
1786297 "type": "integer"
1886297 },
19112271 {
20112271 "type": "number"
21112271 },
22118265 {
23118265 "type": "boolean"
24118265 }
2534637 ]
2611829 },
279001 "maxProperties": 50,
2812225 "propertyNames": {
2937013 "maxLength": 40,
3037013 "minLength": 1
3112225 },
3290160 "type": "object"
3387190 },
34120748 "organization_id": {
35120748 "anyOf": [
36119560 {
3711950 "format": "uuid4",
38119560 "type": "string",
39119560 },
40121243 {
41121243 "type": "null"
42121243 }
43120748 ],
44120748 },
45119071 "properties": {
47119071 },
482191054 "type": {
492191054 "const": "custom",
50120271 "type": "string"
512191054 }
521821109 },
53123754 "required": [
54127318 "type",
55126130 "description",
56126130 "properties"
57123754 ],
58129110 "type": "object"
591601141}
BenefitCustomCreateProperties10 of 10 keywords
1119071{
2928 "properties": {
3928 "note": {
4928 "anyOf": [
5928 {
6928 "anyOf": [
71486 {
81486 "type": "string"
91486 },
107822 {
117822 "type": "null"
127822 }
13928 ],
14928 },
157822 {
167822 "type": "null"
177822 }
18928 ],
19928 }
20928 },
21119863 "type": "object"
22119071}
BenefitDiscordCreate26 of 28 keywords
1821219{
2941197 "properties": {
3117685 "description": {
4118812 "maxLength": 42,
5118812 "minLength": 3,
6120061 "type": "string"
7117685 },
887190 "metadata": {
911829 "additionalProperties": {
1034637 "anyOf": [
11116267 {
121400 "maxLength": 500,
1311624 "minLength": 1,
14140243 "type": "string"
15116267 },
1686297 {
1786297 "type": "integer"
1886297 },
19112271 {
20112271 "type": "number"
21112271 },
22118265 {
23118265 "type": "boolean"
24118265 }
2534637 ]
2611829 },
279001 "maxProperties": 50,
2812225 "propertyNames": {
2937013 "maxLength": 40,
3037013 "minLength": 1
3112225 },
3290160 "type": "object"
3387190 },
34120748 "organization_id": {
35120748 "anyOf": [
36119560 {
3711950 "format": "uuid4",
38119560 "type": "string",
39119560 },
40121243 {
41121243 "type": "null"
42121243 }
43120748 ],
44120748 },
451351126 "properties": {
471351126 },
481731100 "type": {
491731100 "const": "discord",
50120271 "type": "string"
511731100 }
52941197 },
53123754 "required": [
54127318 "type",
55126130 "description",
56126130 "properties"
57123754 ],
58129110 "type": "object"
59821219}
BenefitDiscordCreateProperties8 of 8 keywords
11351126{
214132 "properties": {
316110 "guild_token": {
416110 "type": "string"
516110 },
615912 "kick_member": {
715912 "type": "boolean"
815912 },
915912 "role_id": {
1015912 "type": "string"
1115912 }
1214132 },
131671031 "required": [
141711027 "guild_token",
151711027 "role_id",
161711027 "kick_member"
171671031 ],
18119863 "type": "object"
191351126}
BenefitDownloadablesCreate26 of 28 keywords
1901211{
21021189 "properties": {
3117685 "description": {
4118812 "maxLength": 42,
5118812 "minLength": 3,
6120061 "type": "string"
7117685 },
887190 "metadata": {
911829 "additionalProperties": {
1034637 "anyOf": [
11116267 {
121400 "maxLength": 500,
1311624 "minLength": 1,
14140243 "type": "string"
15116267 },
1686297 {
1786297 "type": "integer"
1886297 },
19112271 {
20112271 "type": "number"
21112271 },
22118265 {
23118265 "type": "boolean"
24118265 }
2534637 ]
2611829 },
279001 "maxProperties": 50,
2812225 "propertyNames": {
2937013 "maxLength": 40,
3037013 "minLength": 1
3112225 },
3290160 "type": "object"
3387190 },
34120748 "organization_id": {
35120748 "anyOf": [
36119560 {
3711950 "format": "uuid4",
38119560 "type": "string",
39119560 },
40121243 {
41121243 "type": "null"
42121243 }
43120748 ],
44120748 },
451421119 "properties": {
471421119 },
481741099 "type": {
491741099 "const": "downloadables",
50120271 "type": "string"
511741099 }
521021189 },
53123754 "required": [
54127318 "type",
55126130 "description",
56126130 "properties"
57123754 ],
58129110 "type": "object"
59901211}
BenefitDownloadablesCreateProperties9 of 12 keywords
11421119{
214432 "properties": {
312610 "archived": {
4170 "additionalProperties": {
5590 "type": "boolean"
6170 },
7170 "propertyNames": {
8590 "format": "uuid4"
9170 },
1012610 "type": "object"
1112610 },
1215222 "files": {
1315410 "items": {
144150 "format": "uuid4",
1541510 "type": "string"
1615410 },
171622 "minItems": 1,
1816410 "type": "array"
1915222 }
2014432 },
211741024 "required": [
221741024 "files"
231741024 ],
24119863 "type": "object"
251421119}
BenefitGitHubRepositoryCreate26 of 28 keywords
1721229{
2841207 "properties": {
3117685 "description": {
4118812 "maxLength": 42,
5118812 "minLength": 3,
6120061 "type": "string"
7117685 },
887190 "metadata": {
911829 "additionalProperties": {
1034637 "anyOf": [
11116267 {
121400 "maxLength": 500,
1311624 "minLength": 1,
14140243 "type": "string"
15116267 },
1686297 {
1786297 "type": "integer"
1886297 },
19112271 {
20112271 "type": "number"
21112271 },
22118265 {
23118265 "type": "boolean"
24118265 }
2534637 ]
2611829 },
279001 "maxProperties": 50,
2812225 "propertyNames": {
2937013 "maxLength": 40,
3037013 "minLength": 1
3112225 },
3290160 "type": "object"
3387190 },
34120748 "organization_id": {
35120748 "anyOf": [
36119560 {
3711950 "format": "uuid4",
38119560 "type": "string",
39119560 },
40121243 {
41121243 "type": "null"
42121243 }
43120748 ],
44120748 },
451261135 "properties": {
471261135 },
481621111 "type": {
491621111 "const": "github_repository",
50120271 "type": "string"
511621111 }
52841207 },
53123754 "required": [
54127318 "type",
55126130 "description",
56126130 "properties"
57123754 ],
58129110 "type": "object"
59721229}
BenefitGitHubRepositoryCreateProperties10 of 10 keywords
11261135{
213332 "properties": {
315112 "permission": {
415112 "enum": [
5113n/a "pull",
611n/a "triage",
76n/a "push",
811n/a "maintain",
910n/a "admin"
1015112 ],
1115310 "type": "string"
1215112 },
1315310 "repository_name": {
1415310 "type": "string"
1515310 },
1615210 "repository_owner": {
1715210 "type": "string"
1815210 }
1913332 },
201581040 "required": [
211621036 "repository_owner",
221631035 "repository_name",
231631035 "permission"
241581040 ],
25119863 "type": "object"
261261135}
BenefitLicenseKeyActivationCreateProperties9 of 9 keywords
122232{
25026 "properties": {
34610 "enable_customer_admin": {
44610 "type": "boolean"
54610 },
65216 "limit": {
7562 "exclusiveMinimum": 0.0,
8562 "maximum": 50.0,
95612 "type": "integer"
105216 }
115026 },
124830 "required": [
136810 "limit",
145622 "enable_customer_admin"
154830 ],
1678176 "type": "object"
1722232}
BenefitLicenseKeyExpirationProperties10 of 10 keywords
125232{
22950 "properties": {
36512 "timeframe": {
46512 "enum": [
534n/a "year",
66n/a "month",
725n/a "day"
86512 ],
96710 "type": "string"
106512 },
113938 "ttl": {
124126 "exclusiveMinimum": 0.0,
136512 "type": "integer"
143938 }
152950 },
16756 "required": [
17774 "ttl",
18774 "timeframe"
19756 ],
2081176 "type": "object"
2125232}
BenefitLicenseKeysCreate26 of 28 keywords
11161185{
21381153 "properties": {
3117685 "description": {
4118812 "maxLength": 42,
5118812 "minLength": 3,
6120061 "type": "string"
7117685 },
887190 "metadata": {
911829 "additionalProperties": {
1034637 "anyOf": [
11116267 {
121400 "maxLength": 500,
1311624 "minLength": 1,
14140243 "type": "string"
15116267 },
1686297 {
1786297 "type": "integer"
1886297 },
19112271 {
20112271 "type": "number"
21112271 },
22118265 {
23118265 "type": "boolean"
24118265 }
2534637 ]
2611829 },
279001 "maxProperties": 50,
2812225 "propertyNames": {
2937013 "maxLength": 40,
3037013 "minLength": 1
3112225 },
3290160 "type": "object"
3387190 },
34120748 "organization_id": {
35120748 "anyOf": [
36119560 {
3711950 "format": "uuid4",
38119560 "type": "string",
39119560 },
40121243 {
41121243 "type": "null"
42121243 }
43120748 ],
44120748 },
451074187 "properties": {
471074187 },
48291982 "type": {
49291982 "const": "license_keys",
50120271 "type": "string"
51291982 }
521381153 },
53123754 "required": [
54127318 "type",
55126130 "description",
56126130 "properties"
57123754 ],
58129110 "type": "object"
591161185}
BenefitLicenseKeysCreateProperties20 of 20 keywords
11074187{
2144124 "properties": {
319064 "activations": {
419064 "anyOf": [
522232 {
722232 },
816886 {
916886 "type": "null"
1016886 }
1119064 ]
1219064 },
1319364 "expires": {
1419364 "anyOf": [
1525232 {
1725232 },
1816889 {
1916889 "type": "null"
2016889 }
2119364 ]
2219364 },
2322712 "limit_usage": {
2422712 "anyOf": [
2520930 {
262112 "exclusiveMinimum": 0.0,
2721128 "type": "integer"
2820930 },
2918221 {
3018221 "type": "null"
3118221 }
3222712 ],
3322712 },
342298 "prefix": {
352298 "anyOf": [
3621216 {
3721216 "type": "string"
3821216 },
3920829 {
4020829 "type": "null"
4120829 }
422298 ],
432298 }
44144124 },
45119863 "type": "object"
461074187}
BenefitMeterCreditCreate26 of 28 keywords
1751226{
2871204 "properties": {
3117685 "description": {
4118812 "maxLength": 42,
5118812 "minLength": 3,
6120061 "type": "string"
7117685 },
887190 "metadata": {
911829 "additionalProperties": {
1034637 "anyOf": [
11116267 {
121400 "maxLength": 500,
1311624 "minLength": 1,
14140243 "type": "string"
15116267 },
1686297 {
1786297 "type": "integer"
1886297 },
19112271 {
20112271 "type": "number"
21112271 },
22118265 {
23118265 "type": "boolean"
24118265 }
2534637 ]
2611829 },
279001 "maxProperties": 50,
2812225 "propertyNames": {
2937013 "maxLength": 40,
3037013 "minLength": 1
3112225 },
3290160 "type": "object"
3387190 },
34120748 "organization_id": {
35120748 "anyOf": [
36119560 {
3711950 "format": "uuid4",
38119560 "type": "string",
39119560 },
40121243 {
41121243 "type": "null"
42121243 }
43120748 ],
44120748 },
451271134 "properties": {
471271134 },
481691104 "type": {
491691104 "const": "meter_credit",
50120271 "type": "string"
511691104 }
52871204 },
53123754 "required": [
54127318 "type",
55126130 "description",
56126130 "properties"
57123754 ],
58129110 "type": "object"
59751226}
BenefitMeterCreditCreateProperties10 of 11 keywords
11271134{
213338 "properties": {
315910 "meter_id": {
41590 "format": "uuid4",
515910 "type": "string"
615910 },
715910 "rollover": {
815910 "type": "boolean"
915910 },
1015118 "units": {
111572 "exclusiveMinimum": 0.0,
121554 "maximum": 2147483647.0,
1315712 "type": "integer"
1415118 }
1513338 },
161651033 "required": [
171691029 "units",
181691029 "rollover",
191691029 "meter_id"
201651033 ],
21119863 "type": "object"
221271134}
Responses
codedescriptionhitsavg
201Benefit created.24322ms
422Validation Error10186ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized303ms
400Bad Request86ms
500Internal Server Error45124ms
Examples
Body: application/json
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"BenefitCustomCreate.organization_id.examples[0]
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"BenefitDiscordCreate.organization_id.examples[0]
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"BenefitGitHubRepositoryCreate.organization_id.examples[0]
"private_repo"BenefitGitHubRepositoryCreateProperties.repository_name.examples[0]
"polarsource"BenefitGitHubRepositoryCreateProperties.repository_owner.examples[0]
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"BenefitDownloadablesCreate.organization_id.examples[0]
{}BenefitDownloadablesCreateProperties.archived
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"BenefitLicenseKeysCreate.organization_id.examples[0]
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"BenefitMeterCreditCreate.organization_id.examples[0]
Path Parameters
id1 / 2
#validinvalidschema
1320{
2320 "format": "uuid4",
332n/a "type": "string",
4320}
Responses
codedescriptionhitsavg
204Benefit deleted.1516ms
403This benefit is not deletable.0never seen
404Benefit not found.96ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized83ms
Path Parameters
id1 / 2
#validinvalidschema
14100{
24100 "format": "uuid4",
3410n/a "type": "string",
44100}
Responses
codedescriptionhitsavg
200Successful Response3516ms
404Benefit not found.326ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized272ms
Path Parameters
id1 / 2
#validinvalidschema
110750{
210750 "format": "uuid4",
31075n/a "type": "string",
410750}
Body
application/json210 / 220
1517523{
2517523 "anyOf": [
3266774 {
5266774 },
647993 {
847993 },
9371003 {
11371003 },
1248992 {
1448992 },
1577963 {
1777963 },
1842998 {
2042998 }
21517523 ],
22517523}
Referenced Components (14)256 of 266 keywords
BenefitCustomProperties12 of 12 keywords
17695{
2713 "properties": {
3713 "note": {
4713 "anyOf": [
5713 {
6713 "anyOf": [
7515 {
8515 "type": "string"
9515 },
10218 {
11218 "type": "null"
12218 }
13713 ],
14713 },
15218 {
16218 "type": "null"
17218 }
18713 ],
19713 }
20713 },
2120364 "required": [
2220364 "note"
2320364 ],
24384318 "type": "object"
257695}
BenefitCustomUpdate28 of 29 keywords
1266774{
2270757 "properties": {
364174 "description": {
464174 "anyOf": [
5615100 {
662812 "maxLength": 42,
762713 "minLength": 3,
864075 "type": "string"
9615100 },
1026689 {
1126689 "type": "null"
1226689 }
1364174 ],
1464174 },
1561993 "metadata": {
164633 "additionalProperties": {
1717458 "anyOf": [
1862170 {
198634 "maxLength": 500,
209624 "minLength": 1,
21120112 "type": "string"
2262170 },
2350182 {
2450182 "type": "integer"
2550182 },
2663169 {
2763169 "type": "number"
2863169 },
2949183 {
3049183 "type": "boolean"
3149183 }
3217458 ]
334633 },
346520 "maxProperties": 50,
355524 "propertyNames": {
3622012 "maxLength": 40,
3722012 "minLength": 1
385524 },
3965260 "type": "object"
4061993 },
41276426 "properties": {
42276426 "anyOf": [
437695 {
457695 },
46269433 {
47269433 "type": "null"
48269433 }
49276426 ]
50276426 },
51325698 "type": {
52325698 "const": "custom",
53101310 "type": "string"
54325698 }
55270757 },
5610234 "required": [
5710234 "type"
5810234 ],
59102713 "type": "object"
60266774}
BenefitDiscordCreateProperties8 of 8 keywords
18694{
21430 "properties": {
33210 "guild_token": {
43210 "type": "string"
53210 },
63210 "kick_member": {
73210 "type": "boolean"
83210 },
93210 "role_id": {
103210 "type": "string"
113210 }
121430 },
1338346 "required": [
1442342 "guild_token",
1542342 "role_id",
1642342 "kick_member"
1738346 ],
18384318 "type": "object"
198694}
BenefitDiscordUpdate28 of 29 keywords
147993{
251976 "properties": {
364174 "description": {
464174 "anyOf": [
5615100 {
662812 "maxLength": 42,
762713 "minLength": 3,
864075 "type": "string"
9615100 },
1026689 {
1126689 "type": "null"
1226689 }
1364174 ],
1464174 },
1561993 "metadata": {
164633 "additionalProperties": {
1717458 "anyOf": [
1862170 {
198634 "maxLength": 500,
209624 "minLength": 1,
21120112 "type": "string"
2262170 },
2350182 {
2450182 "type": "integer"
2550182 },
2663169 {
2763169 "type": "number"
2863169 },
2949183 {
3049183 "type": "boolean"
3149183 }
3217458 ]
334633 },
346520 "maxProperties": 50,
355524 "propertyNames": {
3622012 "maxLength": 40,
3722012 "minLength": 1
385524 },
3965260 "type": "object"
4061993 },
41277425 "properties": {
42277425 "anyOf": [
438694 {
458694 },
46269433 {
47269433 "type": "null"
48269433 }
49277425 ]
50277425 },
51119904 "type": {
52119904 "const": "discord",
53101310 "type": "string"
54119904 }
5551976 },
5610234 "required": [
5710234 "type"
5810234 ],
59102713 "type": "object"
6047993}
BenefitDownloadablesCreateProperties9 of 12 keywords
17695{
2932 "properties": {
32910 "archived": {
400 "additionalProperties": {
500 "type": "boolean"
600 },
700 "propertyNames": {
800 "format": "uuid4"
900 },
102910 "type": "object"
112910 },
121722 "files": {
131910 "items": {
14320 "format": "uuid4",
153210 "type": "string"
161910 },
17272 "minItems": 1,
182910 "type": "array"
191722 }
20932 },
2139345 "required": [
2239345 "files"
2339345 ],
24384318 "type": "object"
257695}
BenefitDownloadablesUpdate28 of 29 keywords
148992{
252975 "properties": {
364174 "description": {
464174 "anyOf": [
5615100 {
662812 "maxLength": 42,
762713 "minLength": 3,
864075 "type": "string"
9615100 },
1026689 {
1126689 "type": "null"
1226689 }
1364174 ],
1464174 },
1561993 "metadata": {
164633 "additionalProperties": {
1717458 "anyOf": [
1862170 {
198634 "maxLength": 500,
209624 "minLength": 1,
21120112 "type": "string"
2262170 },
2350182 {
2450182 "type": "integer"
2550182 },
2663169 {
2763169 "type": "number"
2863169 },
2949183 {
3049183 "type": "boolean"
3149183 }
3217458 ]
334633 },
346520 "maxProperties": 50,
355524 "propertyNames": {
3622012 "maxLength": 40,
3722012 "minLength": 1
385524 },
3965260 "type": "object"
4061993 },
41276426 "properties": {
42276426 "anyOf": [
437695 {
457695 },
46269433 {
47269433 "type": "null"
48269433 }
49276426 ]
50276426 },
51118905 "type": {
52118905 "const": "downloadables",
53101310 "type": "string"
54118905 }
5552975 },
5610234 "required": [
5710234 "type"
5810234 ],
59102713 "type": "object"
6048992}
BenefitGitHubRepositoryCreateProperties10 of 10 keywords
112690{
21832 "properties": {
33612 "permission": {
43612 "enum": [
527n/a "pull",
62n/a "triage",
73n/a "push",
82n/a "maintain",
92n/a "admin"
103612 ],
113810 "type": "string"
123612 },
133810 "repository_name": {
143810 "type": "string"
153810 },
163810 "repository_owner": {
173810 "type": "string"
183810 }
191832 },
2044340 "required": [
2148336 "repository_owner",
2248336 "repository_name",
2348336 "permission"
2444340 ],
25384318 "type": "object"
2612690}
BenefitGitHubRepositoryUpdate28 of 29 keywords
1371003{
241986 "properties": {
364174 "description": {
464174 "anyOf": [
5615100 {
662812 "maxLength": 42,
762713 "minLength": 3,
864075 "type": "string"
9615100 },
1026689 {
1126689 "type": "null"
1226689 }
1364174 ],
1464174 },
1561993 "metadata": {
164633 "additionalProperties": {
1717458 "anyOf": [
1862170 {
198634 "maxLength": 500,
209624 "minLength": 1,
21120112 "type": "string"
2262170 },
2350182 {
2450182 "type": "integer"
2550182 },
2663169 {
2763169 "type": "number"
2863169 },
2949183 {
3049183 "type": "boolean"
3149183 }
3217458 ]
334633 },
346520 "maxProperties": 50,
355524 "propertyNames": {
3622012 "maxLength": 40,
3722012 "minLength": 1
385524 },
3965260 "type": "object"
4061993 },
41281421 "properties": {
42281421 "anyOf": [
4312690 {
4512690 },
46269433 {
47269433 "type": "null"
48269433 }
49281421 ]
50281421 },
51111912 "type": {
52111912 "const": "github_repository",
53101310 "type": "string"
54111912 }
5541986 },
5610234 "required": [
5710234 "type"
5810234 ],
59102713 "type": "object"
60371003}
BenefitLicenseKeyActivationCreateProperties9 of 9 keywords
117124{
22126 "properties": {
33510 "enable_customer_admin": {
43510 "type": "boolean"
53510 },
62916 "limit": {
7332 "exclusiveMinimum": 0.0,
8332 "maximum": 50.0,
93312 "type": "integer"
102916 }
112126 },
12436 "required": [
13454 "limit",
14454 "enable_customer_admin"
15436 ],
164992 "type": "object"
1717124}
BenefitLicenseKeyExpirationProperties10 of 10 keywords
114128{
21826 "properties": {
33012 "timeframe": {
43012 "enum": [
521n/a "year",
66n/a "month",
73n/a "day"
83012 ],
93210 "type": "string"
103012 },
112814 "ttl": {
12302 "exclusiveMinimum": 0.0,
133012 "type": "integer"
142814 }
151826 },
16406 "required": [
17424 "ttl",
18424 "timeframe"
19406 ],
204696 "type": "object"
2114128}
BenefitLicenseKeysCreateProperties20 of 20 keywords
1278424{
245106 "properties": {
310140 "activations": {
410140 "anyOf": [
517124 {
717124 },
88457 {
98457 "type": "null"
108457 }
1110140 ]
1210140 },
1310240 "expires": {
1410240 "anyOf": [
1514128 {
1714128 },
188854 {
198854 "type": "null"
208854 }
2110240 ]
2210240 },
2312118 "limit_usage": {
2412118 "anyOf": [
2511821 {
261202 "exclusiveMinimum": 0.0,
2712019 "type": "integer"
2811821 },
293136 {
303136 "type": "null"
313136 }
3212118 ],
3312118 },
341308 "prefix": {
351308 "anyOf": [
364134 {
374134 "type": "string"
384134 },
3912612 {
4012612 "type": "null"
4112612 }
421308 ],
431308 }
4445106 },
45384318 "type": "object"
46278424}
BenefitLicenseKeysUpdate28 of 29 keywords
177963{
281946 "properties": {
364174 "description": {
464174 "anyOf": [
5615100 {
662812 "maxLength": 42,
762713 "minLength": 3,
864075 "type": "string"
9615100 },
1026689 {
1126689 "type": "null"
1226689 }
1364174 ],
1464174 },
1561993 "metadata": {
164633 "additionalProperties": {
1717458 "anyOf": [
1862170 {
198634 "maxLength": 500,
209624 "minLength": 1,
21120112 "type": "string"
2262170 },
2350182 {
2450182 "type": "integer"
2550182 },
2663169 {
2763169 "type": "number"
2863169 },
2949183 {
3049183 "type": "boolean"
3149183 }
3217458 ]
334633 },
346520 "maxProperties": 50,
355524 "propertyNames": {
3622012 "maxLength": 40,
3722012 "minLength": 1
385524 },
3965260 "type": "object"
4061993 },
41547155 "properties": {
42547155 "anyOf": [
43278424 {
45278424 },
46269433 {
47269433 "type": "null"
48269433 }
49547155 ]
50547155 },
51218805 "type": {
52218805 "const": "license_keys",
53101310 "type": "string"
54218805 }
5581946 },
5610234 "required": [
5710234 "type"
5810234 ],
59102713 "type": "object"
6077963}
BenefitMeterCreditCreateProperties10 of 11 keywords
113689{
21936 "properties": {
34310 "meter_id": {
4430 "format": "uuid4",
54310 "type": "string"
64310 },
74310 "rollover": {
84310 "type": "boolean"
94310 },
103716 "units": {
11412 "exclusiveMinimum": 0.0,
12412 "maximum": 2147483647.0,
134112 "type": "integer"
143716 }
151936 },
1649335 "required": [
1753331 "units",
1853331 "rollover",
1953331 "meter_id"
2049335 ],
21384318 "type": "object"
2213689}
BenefitMeterCreditUpdate28 of 29 keywords
142998{
246981 "properties": {
364174 "description": {
464174 "anyOf": [
5615100 {
662812 "maxLength": 42,
762713 "minLength": 3,
864075 "type": "string"
9615100 },
1026689 {
1126689 "type": "null"
1226689 }
1364174 ],
1464174 },
1561993 "metadata": {
164633 "additionalProperties": {
1717458 "anyOf": [
1862170 {
198634 "maxLength": 500,
209624 "minLength": 1,
21120112 "type": "string"
2262170 },
2350182 {
2450182 "type": "integer"
2550182 },
2663169 {
2763169 "type": "number"
2863169 },
2949183 {
3049183 "type": "boolean"
3149183 }
3217458 ]
334633 },
346520 "maxProperties": 50,
355524 "propertyNames": {
3622012 "maxLength": 40,
3722012 "minLength": 1
385524 },
3965260 "type": "object"
4061993 },
41282420 "properties": {
42282420 "anyOf": [
4313689 {
4513689 },
46269433 {
47269433 "type": "null"
48269433 }
49282420 ]
50282420 },
51120903 "type": {
52120903 "const": "meter_credit",
53101310 "type": "string"
54120903 }
5546981 },
5610234 "required": [
5710234 "type"
5810234 ],
59102713 "type": "object"
6042998}
Responses
codedescriptionhitsavg
200Benefit updated.14519ms
404Benefit not found.2396ms
422Validation Error6616ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized203ms
500Internal Server Error51552ms
400Bad Request55ms
Examples
Body: application/json
"private_repo"BenefitGitHubRepositoryCreateProperties.repository_name.examples[0]
"polarsource"BenefitGitHubRepositoryCreateProperties.repository_owner.examples[0]
{}BenefitDownloadablesCreateProperties.archived
Path Parameters
id2 / 2
#validinvalidschema
13957{
23957 "format": "uuid4",
3402n/a "type": "string",
43957}
Query Parameters
is_granted2 / 3
16235{
26235 "anyOf": [
36235 {
46235 "type": "boolean"
56235 },
6097 {
7097 "type": "null"
8097 }
96235 ],
106235}
customer_id4 / 7
15926{
25926 "anyOf": [
3085 {
400 "format": "uuid4",
50n/a "type": "string"
6085 },
75926 {
85926 "items": {
912169 "format": "uuid4",
10190n/a "type": "string"
115926 },
12850 "type": "array"
135926 },
14085 {
15085 "type": "null"
16085 }
175926 ],
185926}
page2 / 2
18228{
2827 "exclusiveMinimum": 0,
38921 "type": "integer"
48228}
limit2 / 2
17652{
27629 "exclusiveMinimum": 0,
310523 "type": "integer"
47652}
Responses
codedescriptionhitsavg
200Successful Response2587ms
404Benefit not found.257ms
422Validation Error896ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized263ms
500Internal Server Error41384ms
Examples
Query
1page
10limit
checkouts 8 operations 2 covered 6 partial 0 uncovered 0 not measured 82% #
Query Parameters
organization_id2 / 7
#validinvalidschema
16770{
26770 "anyOf": [
30677 {
400 "format": "uuid4",
50n/a "type": "string",
60677 },
76770 {
86770 "items": {
96770 "format": "uuid4",
10677n/a "type": "string",
116770 },
126770 "type": "array"
136770 },
140677 {
150677 "type": "null"
160677 }
176770 ],
186770}
product_id4 / 7
152070{
252070 "anyOf": [
30590 {
400 "format": "uuid4",
50n/a "type": "string",
60590 },
752070 {
852070 "items": {
9573265 "format": "uuid4",
10838n/a "type": "string",
1152070 },
125900 "type": "array"
1352070 },
140590 {
150590 "type": "null"
160590 }
1752070 ],
1852070}
customer_id4 / 7
12639{
22639 "anyOf": [
30272 {
400 "format": "uuid4",
50n/a "type": "string"
60272 },
72639 {
82639 "items": {
94675 "format": "uuid4",
10472n/a "type": "string"
112639 },
122720 "type": "array"
132639 },
140272 {
150272 "type": "null"
160272 }
172639 ],
182639}
status4 / 7
122515{
222515 "anyOf": [
30240 {
50240 },
622515 {
722515 "items": {
922515 },
102400 "type": "array"
1122515 },
120240 {
130240 "type": "null"
140240 }
1522515 ],
1622515}
Referenced Components (1)3 of 3 keywords
CheckoutStatus3 of 3 keywords
11075257{
21075257 "enum": [
3343n/a "open",
4218n/a "expired",
5195n/a "confirmed",
6168n/a "succeeded",
7151n/a "failed"
81075257 ],
91078n/a "type": "string"
101075257}
query3 / 3
1233n/a{
2233n/a "anyOf": [
3211n/a {
4211n/a "type": "string"
5211n/a },
622211 {
722211 "type": "null"
822211 }
9233n/a ],
10233n/a}
page2 / 2
135516{
23552 "exclusiveMinimum": 0,
335714 "type": "integer"
435516}
limit2 / 2
135922{
23592 "exclusiveMinimum": 0,
336120 "type": "integer"
435922}
sorting4 / 6
119984{
219984 "anyOf": [
319984 {
419984 "items": {
619984 },
72830 "type": "array"
819984 },
90283 {
100283 "type": "null"
110283 }
1219984 ],
1319984}
Referenced Components (1)3 of 3 keywords
CheckoutSortProperty3 of 3 keywords
11117115{
21117115 "enum": [
383n/a "created_at",
4132n/a "-created_at",
592n/a "expires_at",
698n/a "-expires_at",
7578n/a "status",
8134n/a "-status"
91117115 ],
101203n/a "type": "string"
111117115}
Responses
codedescriptionhitsavg
200Successful Response47323ms
422Validation Error1236ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized753ms
500Internal Server Error61632ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-created_at" ]sorting
Body
application/json157 / 227
CheckoutCreate
#validinvalidschema
11110405{
31110405}
Referenced Components (10)196 of 279 keywords
AddressInput28 of 28 keywords
1533540{
253664 "properties": {
35628 "city": {
45628 "anyOf": [
54566 {
64566 "type": "string"
74566 },
855812 {
955812 "type": "null"
1055812 }
115628 ],
125628 },
1358512 "country": {
1458512 "enum": [
1511n/a "AD",
162n/a "AE",
172n/a "AF",
182n/a "AG",
192n/a "AI",
202n/a "AL",
212n/a "AM",
222n/a "AO",
232n/a "AQ",
242n/a "AR",
252n/a "AS",
262n/a "AT",
272n/a "AU",
284n/a "AW",
292n/a "AX",
302n/a "AZ",
312n/a "BA",
322n/a "BB",
332n/a "BD",
342n/a "BE",
352n/a "BF",
362n/a "BG",
372n/a "BH",
382n/a "BI",
392n/a "BJ",
402n/a "BL",
413n/a "BM",
422n/a "BN",
432n/a "BO",
442n/a "BQ",
452n/a "BR",
462n/a "BS",
472n/a "BT",
482n/a "BV",
493n/a "BW",
502n/a "BY",
512n/a "BZ",
522n/a "CA",
532n/a "CC",
542n/a "CD",
552n/a "CF",
562n/a "CG",
572n/a "CH",
582n/a "CI",
592n/a "CK",
602n/a "CL",
612n/a "CM",
622n/a "CN",
632n/a "CO",
642n/a "CR",
652n/a "CV",
662n/a "CW",
672n/a "CX",
682n/a "CY",
692n/a "CZ",
702n/a "DE",
712n/a "DJ",
722n/a "DK",
732n/a "DM",
742n/a "DO",
752n/a "DZ",
762n/a "EC",
772n/a "EE",
782n/a "EG",
792n/a "EH",
802n/a "ER",
812n/a "ES",
822n/a "ET",
832n/a "FI",
842n/a "FJ",
852n/a "FK",
862n/a "FM",
872n/a "FO",
882n/a "FR",
892n/a "GA",
902n/a "GB",
912n/a "GD",
922n/a "GE",
932n/a "GF",
942n/a "GG",
952n/a "GH",
962n/a "GI",
972n/a "GL",
982n/a "GM",
993n/a "GN",
1002n/a "GP",
1012n/a "GQ",
1022n/a "GR",
1032n/a "GS",
1042n/a "GT",
1052n/a "GU",
1062n/a "GW",
1072n/a "GY",
1082n/a "HK",
1092n/a "HM",
1102n/a "HN",
1112n/a "HR",
1122n/a "HT",
1132n/a "HU",
1142n/a "ID",
1152n/a "IE",
1162n/a "IL",
1172n/a "IM",
1182n/a "IN",
1192n/a "IO",
1202n/a "IQ",
1212n/a "IS",
1222n/a "IT",
1232n/a "JE",
1242n/a "JM",
1252n/a "JO",
1262n/a "JP",
1272n/a "KE",
1282n/a "KG",
1292n/a "KH",
1302n/a "KI",
1313n/a "KM",
1322n/a "KN",
1332n/a "KR",
1342n/a "KW",
1352n/a "KY",
1362n/a "KZ",
1372n/a "LA",
1382n/a "LB",
1392n/a "LC",
1402n/a "LI",
1412n/a "LK",
1422n/a "LR",
1432n/a "LS",
1442n/a "LT",
1452n/a "LU",
1462n/a "LV",
1472n/a "LY",
1482n/a "MA",
1494n/a "MC",
1502n/a "MD",
1513n/a "ME",
1522n/a "MF",
1532n/a "MG",
1542n/a "MH",
1552n/a "MK",
1562n/a "ML",
1572n/a "MM",
1582n/a "MN",
1592n/a "MO",
1602n/a "MP",
1612n/a "MQ",
1622n/a "MR",
1632n/a "MS",
1642n/a "MT",
1652n/a "MU",
1662n/a "MV",
1672n/a "MW",
1682n/a "MX",
1692n/a "MY",
1702n/a "MZ",
1712n/a "NA",
1722n/a "NC",
1732n/a "NE",
1742n/a "NF",
1753n/a "NG",
1762n/a "NI",
1772n/a "NL",
1782n/a "NO",
1792n/a "NP",
1802n/a "NR",
1812n/a "NU",
1822n/a "NZ",
1832n/a "OM",
1842n/a "PA",
1853n/a "PE",
1862n/a "PF",
1872n/a "PG",
1882n/a "PH",
1892n/a "PK",
1902n/a "PL",
1912n/a "PM",
1922n/a "PN",
1932n/a "PR",
1942n/a "PS",
1952n/a "PT",
1962n/a "PW",
1972n/a "PY",
1982n/a "QA",
1992n/a "RE",
2002n/a "RO",
2012n/a "RS",
2022n/a "RW",
2032n/a "SA",
2042n/a "SB",
2052n/a "SC",
2062n/a "SD",
2072n/a "SE",
2082n/a "SG",
2093n/a "SH",
2102n/a "SI",
2112n/a "SJ",
2122n/a "SK",
2132n/a "SL",
2142n/a "SM",
2152n/a "SN",
2162n/a "SO",
2172n/a "SR",
2182n/a "SS",
2192n/a "ST",
2203n/a "SV",
2212n/a "SX",
2222n/a "SZ",
2232n/a "TC",
2242n/a "TD",
2252n/a "TF",
2262n/a "TG",
2272n/a "TH",
2282n/a "TJ",
2292n/a "TK",
2303n/a "TL",
2312n/a "TM",
2322n/a "TN",
2332n/a "TO",
2342n/a "TR",
2352n/a "TT",
2362n/a "TV",
2372n/a "TW",
2382n/a "TZ",
2393n/a "UA",
2403n/a "UG",
2412n/a "UM",
24270n/a "US",
2432n/a "UY",
2443n/a "UZ",
2452n/a "VA",
2462n/a "VC",
2475n/a "VE",
2482n/a "VG",
2492n/a "VI",
2502n/a "VN",
2512n/a "VU",
2522n/a "WF",
2532n/a "WS",
2542n/a "YE",
2552n/a "YT",
2562n/a "ZA",
2572n/a "ZM",
2582n/a "ZW"
25958512 ],
26058710 "type": "string",
26158512 },
26256419 "line1": {
26356419 "anyOf": [
26412571 {
26512571 "type": "string"
26612571 },
26755231 {
26855231 "type": "null"
26955231 }
27056419 ],
27156419 },
2725658 "line2": {
2735658 "anyOf": [
27410563 {
27510563 "type": "string"
27610563 },
27755518 {
27855518 "type": "null"
27955518 }
2805658 ],
2815658 },
2825608 "postal_code": {
2835608 "anyOf": [
2844564 {
2854564 "type": "string"
2864564 },
28755612 {
28855612 "type": "null"
28955612 }
2905608 ],
2915608 },
2925589 "state": {
2935589 "anyOf": [
2947560 {
2957560 "type": "string"
2967560 },
29755116 {
29855116 "type": "null"
29955116 }
3005589 ],
3015589 }
30253664 },
3035975 "required": [
3045975 "country"
3055975 ],
306602471 "type": "object"
307533540}
CheckoutProductsCreate134 of 146 keywords
11110405{
21130374 "properties": {
3108310 "allow_discount_codes": {
4108310 "type": "boolean"
5108310 },
6103911 "allow_trial": {
7103911 "type": "boolean"
8103911 },
9103416 "amount": {
10103416 "anyOf": [
11101733 {
1210232 "maximum": 99999999.0,
1310196 "minimum": 50.0,
14102327 "type": "integer"
15101733 },
16171033 {
17171033 "type": "null"
18171033 }
19103416 ],
20103416 },
21102516 "custom_field_data": {
22396 "additionalProperties": {
231036 "anyOf": [
243178 {
253178 "type": "string"
263178 },
271594 {
281594 "type": "integer"
291594 },
302881 {
312881 "type": "boolean"
322881 },
332107 {
34229 "format": "date-time",
353178 "type": "string"
362107 },
372980 {
382980 "type": "null"
392980 }
401036 ]
41396 },
42103110 "type": "object"
43102516 },
4499479 "customer_billing_address": {
4599479 "anyOf": [
46533540 {
48533540 },
49461612 {
50461612 "type": "null"
51461612 }
5299479 ]
5399479 },
5410258 "customer_billing_name": {
5510258 "anyOf": [
56181015 {
57181015 "type": "string"
58181015 },
59100726 {
60100726 "type": "null"
61100726 }
6210258 ],
6310258 },
64103512 "customer_email": {
65103512 "anyOf": [
66100542 {
6710434 "format": "email",
68100938 "type": "string"
69100542 },
70301017 {
71301017 "type": "null"
72301017 }
73103512 ],
74103512 },
7510258 "customer_id": {
7610258 "anyOf": [
77101320 {
7810130 "format": "uuid4",
79101320 "type": "string"
80101320 },
81121021 {
82121021 "type": "null"
83121021 }
8410258 ],
8510258 },
8610338 "customer_ip_address": {
8710338 "anyOf": [
88101625 {
8900 "format": "ipvanyaddress",
90101625 "type": "string"
91101625 },
92171024 {
93171024 "type": "null"
94171024 }
9510338 ],
9610338 },
97103614 "customer_metadata": {
98354 "additionalProperties": {
99914 "anyOf": [
1003164 {
101350 "maxLength": 500,
102314 "minLength": 1,
1033560 "type": "string"
1043164 },
1051877 {
1061877 "type": "integer"
1071877 },
1082867 {
1092867 "type": "number"
1102867 },
1113263 {
1123263 "type": "boolean"
1133263 }
114914 ]
115354 },
11610400 "maxProperties": 50,
117354 "propertyNames": {
118932 "maxLength": 40,
119932 "minLength": 1
120354 },
121104010 "type": "object"
122103614 },
123103610 "customer_name": {
124103610 "anyOf": [
125101828 {
12610182 "maxLength": 256,
127102026 "type": "string"
128101828 },
129181028 {
130181028 "type": "null"
131181028 }
132103610 ],
133103610 },
13410358 "customer_tax_id": {
13510358 "anyOf": [
136191024 {
137191024 "type": "string"
138191024 },
139101627 {
140101627 "type": "null"
141101627 }
14210358 ],
14310358 },
14410299 "discount_id": {
14510299 "anyOf": [
146100434 {
14710041 "format": "uuid4",
148100533 "type": "string"
149100434 },
150251013 {
151251013 "type": "null"
152251013 }
15310299 ],
15410299 },
15510288 "embed_origin": {
15610288 "anyOf": [
157191017 {
158191017 "type": "string"
159191017 },
160100927 {
161100927 "type": "null"
162100927 }
16310288 ],
16410288 },
165101716 "external_customer_id": {
166101716 "anyOf": [
167291004 {
168291004 "type": "string"
169291004 },
17098845 {
17198845 "type": "null"
17298845 }
173101716 ],
174101716 },
175101910 "is_business_customer": {
176101910 "type": "boolean"
177101910 },
178101314 "metadata": {
179334 "additionalProperties": {
180874 "anyOf": [
1812764 {
182310 "maxLength": 500,
183274 "minLength": 1,
1843160 "type": "string"
1852764 },
1861378 {
1871378 "type": "integer"
1881378 },
1892269 {
1902269 "type": "number"
1912269 },
1923853 {
1933853 "type": "boolean"
1943853 }
195874 ]
196334 },
19710170 "maxProperties": 50,
198334 "propertyNames": {
199892 "maxLength": 40,
200892 "minLength": 1
201334 },
202101710 "type": "object"
203101314 },
204101312 "prices": {
205101312 "anyOf": [
20699926 {
207140 "additionalProperties": {
208300 "items": {
209920 "oneOf": [
2102963 {
2122963 },
2131478 {
2151478 },
2161478 {
2181478 },
2191181 {
2211181 },
2222468 {
2242468 }
225920 ]
226300 },
227300 "minItems": 1,
228300 "type": "array"
229140 },
230140 "propertyNames": {
231300 "format": "uuid4"
232140 },
23399926 "type": "object"
23499926 },
235141011 {
236141011 "type": "null"
237141011 }
238101312 ],
239101312 },
240146222 "products": {
241146410 "items": {
24223980 "format": "uuid4",
243239810 "type": "string"
244146410 },
24514722 "minItems": 1,
246147410 "type": "array"
247146222 },
24899210 "require_billing_address": {
24999210 "type": "boolean"
25099210 },
251101816 "return_url": {
252101816 "anyOf": [
253100232 {
25410046 "format": "uri",
25510082 "maxLength": 2083,
25610082 "minLength": 1,
257101024 "type": "string"
258100232 },
259161018 {
260161018 "type": "null"
261161018 }
262101816 ],
263101816 },
26499214 "seats": {
26599214 "anyOf": [
26697729 {
2679812 "maximum": 1000.0,
2689794 "minimum": 1.0,
26998125 "type": "integer"
27097729 },
27115991 {
27215991 "type": "null"
27315991 }
27499214 ],
27599214 },
27698819 "subscription_id": {
27798819 "anyOf": [
27897136 {
27997111 "format": "uuid4",
28098225 "type": "string"
28197136 },
28217990 {
28317990 "type": "null"
28417990 }
28598819 ],
28698819 },
28798516 "success_url": {
28898516 "anyOf": [
28996635 {
2909686 "format": "uri",
2919722 "maxLength": 2083,
2929722 "minLength": 1,
29397427 "type": "string"
29496635 },
29519982 {
29619982 "type": "null"
29719982 }
29898516 ],
29998516 },
300101010 "trial_interval": {
301101010 "anyOf": [
30227993 {
30427993 },
30598337 {
30698337 "type": "null"
30798337 }
308101010 ],
309101010 },
31098815 "trial_interval_count": {
31198815 "anyOf": [
31297330 {
3139782 "maximum": 1000.0,
3149755 "minimum": 1.0,
31597726 "type": "integer"
31697330 },
31715988 {
31815988 "type": "null"
31915988 }
32098815 ],
32198815 }
3221130374 },
323148421 "required": [
324148421 "products"
325148421 ],
326150510 "type": "object"
3271110405}
ProductPriceCustomCreate7 of 27 keywords
11478{
21478 "properties": {
31478 "amount_type": {
41478 "const": "custom",
5920 "type": "string"
61478 },
760 "maximum_amount": {
860 "anyOf": [
960 {
1060 "maximum": 1000000.0,
1160 "minimum": 50.0,
1260 "type": "integer"
1360 },
1406 {
1506 "type": "null"
1606 }
1760 ],
1860 },
1960 "minimum_amount": {
2060 "anyOf": [
2142 {
2240 "maximum": 99999999.0,
2340 "minimum": 50.0,
2442 "type": "integer"
2542 },
2624 {
2724 "type": "null"
2824 }
2960 ],
3060 },
3160 "preset_amount": {
3260 "anyOf": [
3333 {
3430 "maximum": 1000000.0,
3530 "minimum": 50.0,
3633 "type": "integer"
3733 },
3833 {
3933 "type": "null"
4033 }
4160 ],
4260 },
43370 "price_currency": {
44370 "pattern": "usd",
45370 "type": "string"
46370 }
471478 },
48920 "required": [
49920 "amount_type"
50920 ],
51920 "type": "object"
521478}
ProductPriceFixedCreate5 of 12 keywords
12963{
22963 "properties": {
32963 "amount_type": {
42963 "const": "fixed",
5920 "type": "string"
62963 },
7290 "price_amount": {
8290 "maximum": 99999999.0,
9290 "minimum": 50.0,
10290 "type": "integer"
11290 },
12370 "price_currency": {
13370 "pattern": "usd",
14370 "type": "string"
15370 }
162963 },
172963 "required": [
18920 "amount_type",
192963 "price_amount"
202963 ],
21920 "type": "object"
222963}
ProductPriceFreeCreate3 of 7 keywords
11478{
21478 "properties": {
31478 "amount_type": {
41478 "const": "free",
5920 "type": "string"
61478 }
71478 },
8920 "required": [
9920 "amount_type"
10920 ],
11920 "type": "object"
121478}
ProductPriceMeteredUnitCreate9 of 23 keywords
12468{
22468 "properties": {
32468 "amount_type": {
42468 "const": "metered_unit",
5920 "type": "string"
62468 },
7100 "cap_amount": {
8100 "anyOf": [
973 {
1070 "maximum": 2147483647.0,
1170 "minimum": 0.0,
1273 "type": "integer"
1373 },
1437 {
1537 "type": "null"
1637 }
17100 ],
18100 },
19240 "meter_id": {
20240 "format": "uuid4",
21240 "type": "string"
22240 },
23370 "price_currency": {
24370 "pattern": "usd",
25370 "type": "string"
26370 },
27240 "unit_amount": {
28240 "anyOf": [
291311 {
30130 "exclusiveMinimum": 0.0,
311311 "type": "number"
321311 },
331113 {
34110 "pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,5}|(?=[\\d.]{1,18}0*$)\\d{0,5}\\.\\d{0,12}0*$)",
351113 "type": "string"
361113 }
37240 ],
38240 }
392468 },
402468 "required": [
41920 "amount_type",
422468 "meter_id",
432468 "unit_amount"
442468 ],
45920 "type": "object"
462468}
ProductPriceSeatBasedCreate5 of 10 keywords
11181{
21181 "properties": {
31181 "amount_type": {
41181 "const": "seat_based",
5920 "type": "string"
61181 },
7370 "price_currency": {
8370 "pattern": "usd",
9370 "type": "string"
10370 },
11110 "seat_tiers": {
13110 }
141181 },
151181 "required": [
16920 "amount_type",
171181 "seat_tiers"
181181 ],
19920 "type": "object"
201181}
ProductPriceSeatTier2 of 15 keywords
1390{
2390 "properties": {
3180 "max_seats": {
4180 "anyOf": [
5162 {
6160 "minimum": 1.0,
7162 "type": "integer"
8162 },
9216 {
10216 "type": "null"
11216 }
12180 ],
13180 },
14390 "min_seats": {
15390 "minimum": 1.0,
16390 "type": "integer"
17390 },
18390 "price_per_seat": {
19390 "maximum": 99999999.0,
20390 "minimum": 0.0,
21390 "type": "integer"
22390 }
23390 },
24390 "required": [
25390 "min_seats",
26390 "price_per_seat"
27390 ],
28390 "type": "object"
29390}
ProductPriceSeatTiers0 of 8 keywords
1110{
2110 "properties": {
3110 "tiers": {
4110 "items": {
6110 },
7110 "minItems": 1,
8110 "type": "array"
9110 }
10110 },
11110 "required": [
12110 "tiers"
13110 ],
14110 "type": "object"
15110}
TrialInterval3 of 3 keywords
127993{
227993 "enum": [
39n/a "day",
43n/a "week",
56n/a "month",
69n/a "year"
727993 ],
829991 "type": "string"
927993}
Responses
codedescriptionhitsavg
201Checkout session created.0never seen
422Validation Error15086ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error10841ms
401Unauthorized312ms
400Bad Request334ms
Examples
Body: application/json
trueCheckoutProductsCreate.allow_discount_codes
trueCheckoutProductsCreate.allow_trial
"US"AddressInput.country.examples[0]
"SE"AddressInput.country.examples[1]
"FR"AddressInput.country.examples[2]
"John Doe"CheckoutProductsCreate.customer_name.examples[0]
falseCheckoutProductsCreate.is_business_customer
"usd"ProductPriceFixedCreate.price_currency
"usd"ProductPriceCustomCreate.price_currency
"usd"ProductPriceSeatBasedCreate.price_currency
"usd"ProductPriceMeteredUnitCreate.price_currency
falseCheckoutProductsCreate.require_billing_address
Body
application/json17 / 18
CheckoutCreatePublic
#validinvalidschema
157145{
257528 "properties": {
31427 "customer_email": {
41427 "anyOf": [
510841 {
61463 "format": "email",
711138 "type": "string"
810841 },
934115 {
1034115 "type": "null"
1134115 }
121427 ],
131427 },
145945 "product_id": {
155940 "format": "uuid4",
165945 "type": "string"
175945 },
1812813 "seats": {
1912813 "anyOf": [
206972 {
21711 "maximum": 1000.0,
22702 "minimum": 1.0,
237170 "type": "integer"
246972 },
255982 {
265982 "type": "null"
275982 }
2812813 ],
2912813 },
3019310 "subscription_id": {
3119310 "anyOf": [
3216043 {
331605 "format": "uuid4",
3416538 "type": "string"
3516043 },
3633170 {
3733170 "type": "null"
3833170 }
3919310 ],
4019310 }
4157528 },
4259912 "required": [
4359912 "product_id"
4459912 ],
456115 "type": "object"
4657145}
Responses
codedescriptionhitsavg
201Successful Response458241ms
422Validation Error17514ms
Path Parameters
client_secret1 / 1
#validinvalidschema
1429n/a{
2429n/a "type": "string"
3429n/a}
Responses
codedescriptionhitsavg
200Successful Response18612ms
404Checkout session not found.2435ms
410The checkout session is expired.0never seen
422Validation Error0never seen
Path Parameters
client_secret1 / 1
#validinvalidschema
1692n/a{
2692n/a "type": "string"
3692n/a}
Body
application/json74 / 75
CheckoutUpdatePublic
1471147{
2422137 "properties": {
34567 "allow_trial": {
44567 "anyOf": [
526437 {
626437 "const": false,
726437 "type": "boolean"
826437 },
943033 {
1043033 "type": "null"
1143033 }
124567 ],
134567 },
1443919 "amount": {
1543919 "anyOf": [
1641246 {
174215 "maximum": 99999999.0,
184179 "minimum": 50.0,
1942533 "type": "integer"
2041246 },
2127431 {
2227431 "type": "null"
2327431 }
2443919 ],
2543919 },
2643720 "custom_field_data": {
27445 "additionalProperties": {
281185 "anyOf": [
294578 {
304578 "type": "string"
314578 },
3221102 {
3321102 "type": "integer"
3421102 },
352598 {
362598 "type": "boolean"
372598 },
381122 {
39144 "format": "date-time",
404578 "type": "string"
411122 },
422796 {
432796 "type": "null"
442796 }
451185 ]
46445 },
4744215 "type": "object"
4843720 },
4946841 "customer_billing_address": {
5046841 "anyOf": [
51327182 {
53327182 },
54141368 {
55141368 "type": "null"
56141368 }
5746841 ]
5846841 },
5944911 "customer_billing_name": {
6044911 "anyOf": [
6132428 {
6232428 "type": "string"
6332428 },
6441743 {
6541743 "type": "null"
6641743 }
6744911 ],
6844911 },
694609 "customer_email": {
704609 "anyOf": [
7144623 {
724672 "format": "email",
7344821 "type": "string"
7444623 },
7514455 {
7614455 "type": "null"
7714455 }
784609 ],
794609 },
8044210 "customer_name": {
8144210 "anyOf": [
8243121 {
834311 "maxLength": 256,
8443220 "type": "string"
8543121 },
8611441 {
8711441 "type": "null"
8811441 }
8944210 ],
9044210 },
914265 "customer_tax_id": {
924265 "anyOf": [
9322409 {
9422409 "type": "string"
9522409 },
9640427 {
9740427 "type": "null"
9840427 }
994265 ],
1004265 },
1014255 "discount_code": {
1024255 "anyOf": [
10322408 {
10422408 "type": "string"
10522408 },
10640327 {
10740327 "type": "null"
10840327 }
1094255 ],
1104255 },
1114547 "is_business_customer": {
1124547 "anyOf": [
11325436 {
11425436 "type": "boolean"
11525436 },
11642932 {
11742932 "type": "null"
11842932 }
1194547 ],
1204547 },
12143211 "product_id": {
12243211 "anyOf": [
12341330 {
1244130 "format": "uuid4",
12541330 "type": "string"
12641330 },
12719424 {
12819424 "type": "null"
12919424 }
13043211 ],
13143211 },
13244714 "product_price_id": {
13344714 "anyOf": [
13442338 {
1354231 "format": "uuid4",
13642437 "type": "string"
13742338 },
13824437 {
13924437 "type": "null"
14024437 }
14144714 ],
14244714 },
14342516 "seats": {
14442516 "anyOf": [
14541130 {
1464131 "maximum": 1000.0,
1474122 "minimum": 1.0,
14841328 "type": "integer"
14941130 },
15014427 {
15114427 "type": "null"
15214427 }
15342516 ],
15442516 }
155422137 },
15660810 "type": "object"
157471147}
Referenced Components (1)28 of 28 keywords
AddressInput28 of 28 keywords
1327182{
232831 "properties": {
33184 "city": {
43184 "anyOf": [
524298 {
624298 "type": "string"
724298 },
829428 {
929428 "type": "null"
1029428 }
113184 ],
123184 },
133526 "country": {
143526 "enum": [
1521n/a "AD",
163n/a "AE",
171n/a "AF",
181n/a "AG",
191n/a "AI",
201n/a "AL",
211n/a "AM",
221n/a "AO",
231n/a "AQ",
241n/a "AR",
251n/a "AS",
261n/a "AT",
271n/a "AU",
281n/a "AW",
291n/a "AX",
301n/a "AZ",
311n/a "BA",
321n/a "BB",
3311n/a "BD",
341n/a "BE",
351n/a "BF",
363n/a "BG",
371n/a "BH",
381n/a "BI",
392n/a "BJ",
401n/a "BL",
411n/a "BM",
421n/a "BN",
431n/a "BO",
441n/a "BQ",
451n/a "BR",
461n/a "BS",
471n/a "BT",
481n/a "BV",
491n/a "BW",
501n/a "BY",
511n/a "BZ",
521n/a "CA",
531n/a "CC",
541n/a "CD",
551n/a "CF",
561n/a "CG",
571n/a "CH",
581n/a "CI",
591n/a "CK",
601n/a "CL",
611n/a "CM",
621n/a "CN",
631n/a "CO",
642n/a "CR",
651n/a "CV",
661n/a "CW",
673n/a "CX",
681n/a "CY",
691n/a "CZ",
701n/a "DE",
711n/a "DJ",
721n/a "DK",
731n/a "DM",
741n/a "DO",
751n/a "DZ",
761n/a "EC",
771n/a "EE",
781n/a "EG",
791n/a "EH",
801n/a "ER",
811n/a "ES",
821n/a "ET",
831n/a "FI",
841n/a "FJ",
851n/a "FK",
861n/a "FM",
877n/a "FO",
882n/a "FR",
891n/a "GA",
901n/a "GB",
911n/a "GD",
921n/a "GE",
931n/a "GF",
941n/a "GG",
951n/a "GH",
961n/a "GI",
971n/a "GL",
981n/a "GM",
991n/a "GN",
1002n/a "GP",
1011n/a "GQ",
1021n/a "GR",
1031n/a "GS",
1041n/a "GT",
1051n/a "GU",
1061n/a "GW",
1071n/a "GY",
1081n/a "HK",
1091n/a "HM",
1101n/a "HN",
1111n/a "HR",
1121n/a "HT",
1132n/a "HU",
1141n/a "ID",
1151n/a "IE",
1161n/a "IL",
1172n/a "IM",
1181n/a "IN",
1191n/a "IO",
1201n/a "IQ",
1211n/a "IS",
1221n/a "IT",
1231n/a "JE",
1241n/a "JM",
1251n/a "JO",
1262n/a "JP",
1271n/a "KE",
1281n/a "KG",
1291n/a "KH",
1301n/a "KI",
1311n/a "KM",
1321n/a "KN",
1331n/a "KR",
1343n/a "KW",
1351n/a "KY",
1361n/a "KZ",
1371n/a "LA",
1381n/a "LB",
1391n/a "LC",
1403n/a "LI",
1411n/a "LK",
1421n/a "LR",
1431n/a "LS",
1443n/a "LT",
1452n/a "LU",
1461n/a "LV",
1471n/a "LY",
1481n/a "MA",
1491n/a "MC",
1501n/a "MD",
1511n/a "ME",
1521n/a "MF",
1531n/a "MG",
1541n/a "MH",
1551n/a "MK",
1561n/a "ML",
1571n/a "MM",
1581n/a "MN",
1591n/a "MO",
1601n/a "MP",
1611n/a "MQ",
1621n/a "MR",
1631n/a "MS",
1641n/a "MT",
1651n/a "MU",
1662n/a "MV",
1671n/a "MW",
1681n/a "MX",
1691n/a "MY",
1701n/a "MZ",
1711n/a "NA",
1721n/a "NC",
1731n/a "NE",
1741n/a "NF",
1752n/a "NG",
1761n/a "NI",
1771n/a "NL",
1781n/a "NO",
1791n/a "NP",
1803n/a "NR",
1811n/a "NU",
1821n/a "NZ",
1831n/a "OM",
1841n/a "PA",
1851n/a "PE",
1861n/a "PF",
1871n/a "PG",
1882n/a "PH",
1891n/a "PK",
1901n/a "PL",
1911n/a "PM",
1921n/a "PN",
1931n/a "PR",
1941n/a "PS",
1951n/a "PT",
1961n/a "PW",
1971n/a "PY",
1981n/a "QA",
1991n/a "RE",
2001n/a "RO",
2011n/a "RS",
2021n/a "RW",
2031n/a "SA",
2041n/a "SB",
2051n/a "SC",
2061n/a "SD",
2072n/a "SE",
2081n/a "SG",
2091n/a "SH",
2101n/a "SI",
2111n/a "SJ",
2121n/a "SK",
2131n/a "SL",
2141n/a "SM",
2151n/a "SN",
2161n/a "SO",
2171n/a "SR",
2182n/a "SS",
2191n/a "ST",
2201n/a "SV",
2212n/a "SX",
2221n/a "SZ",
2231n/a "TC",
2241n/a "TD",
2254n/a "TF",
2261n/a "TG",
2272n/a "TH",
2281n/a "TJ",
2291n/a "TK",
2301n/a "TL",
2311n/a "TM",
2321n/a "TN",
2331n/a "TO",
2341n/a "TR",
2351n/a "TT",
2361n/a "TV",
2371n/a "TW",
2384n/a "TZ",
2391n/a "UA",
2401n/a "UG",
2411n/a "UM",
24236n/a "US",
2431n/a "UY",
2441n/a "UZ",
2451n/a "VA",
2461n/a "VC",
2471n/a "VE",
2481n/a "VG",
2491n/a "VI",
2501n/a "VN",
2511n/a "VU",
2521n/a "WF",
2531n/a "WS",
2543n/a "YE",
2551n/a "YT",
2561n/a "ZA",
2571n/a "ZM",
2581n/a "ZW"
2593526 ],
2603535 "type": "string",
2613526 },
2623024 "line1": {
2633024 "anyOf": [
26413293 {
26513293 "type": "string"
26613293 },
26728917 {
26828917 "type": "null"
26928917 }
2703024 ],
2713024 },
2723135 "line2": {
2733135 "anyOf": [
27414304 {
27514304 "type": "string"
27614304 },
27729919 {
27829919 "type": "null"
27929919 }
2803135 ],
2813135 },
2823135 "postal_code": {
2833135 "anyOf": [
28414304 {
28514304 "type": "string"
28614304 },
28729919 {
28829919 "type": "null"
28929919 }
2903135 ],
2913135 },
2923117 "state": {
2933117 "anyOf": [
2948310 {
2958310 "type": "string"
2968310 },
29730315 {
29830315 "type": "null"
29930315 }
3003117 ],
3013117 }
30232831 },
3033582 "required": [
3043582 "country"
3053582 ],
306360149 "type": "object"
307327182}
Responses
codedescriptionhitsavg
200Checkout session updated.5729ms
403The checkout is expired, the customer already has an active subscription, or the organization is not ready to accept payments.0never seen
404Checkout session not found.5518ms
410The checkout session is expired.0never seen
422Validation Error5134ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error10927ms
400Bad Request578ms
Examples
Body: application/json
"US"AddressInput.country.examples[0]
"SE"AddressInput.country.examples[1]
"FR"AddressInput.country.examples[2]
"John Doe"CheckoutUpdatePublic.customer_name.examples[0]
Path Parameters
client_secret1 / 1
#validinvalidschema
1572n/a{
2572n/a "type": "string"
3572n/a}
Body
application/json77 / 78
CheckoutConfirmStripe
1390116{
2365111 "properties": {
34325 "allow_trial": {
44325 "anyOf": [
55432 {
65432 "const": false,
75432 "type": "boolean"
85432 },
942710 {
1042710 "type": "null"
1142710 }
124325 ],
134325 },
1442415 "amount": {
1542415 "anyOf": [
1641326 {
174201 "maximum": 99999999.0,
184147 "minimum": 50.0,
1942019 "type": "integer"
2041326 },
2111428 {
2211428 "type": "null"
2311428 }
2442415 ],
2542415 },
264314 "confirmation_token_id": {
274314 "anyOf": [
284431 {
294431 "type": "string"
304431 },
314278 {
324278 "type": "null"
334278 }
344314 ],
354314 },
364239 "custom_field_data": {
37314 "additionalProperties": {
38444 "anyOf": [
392325 {
402325 "type": "string"
412325 },
42741 {
43741 "type": "integer"
44741 },
45642 {
46642 "type": "boolean"
47642 },
48147 {
49122 "format": "date-time",
502325 "type": "string"
51147 },
52840 {
53840 "type": "null"
54840 }
55444 ]
56314 },
574275 "type": "object"
584239 },
5939433 "customer_billing_address": {
6039433 "anyOf": [
61269158 {
63269158 },
64125302 {
65125302 "type": "null"
66125302 }
6739433 ]
6839433 },
694294 "customer_billing_name": {
704294 "anyOf": [
7121412 {
7221412 "type": "string"
7321412 },
7440825 {
7540825 "type": "null"
7640825 }
774294 ],
784294 },
794316 "customer_email": {
804316 "anyOf": [
8141918 {
824352 "format": "email",
8342116 "type": "string"
8441918 },
8512425 {
8612425 "type": "null"
8712425 }
884316 ],
894316 },
904199 "customer_name": {
914199 "anyOf": [
9241117 {
934111 "maxLength": 256,
9441216 "type": "string"
9541117 },
968420 {
978420 "type": "null"
988420 }
994199 ],
1004199 },
1014284 "customer_tax_id": {
1024284 "anyOf": [
10321411 {
10421411 "type": "string"
10521411 },
10640725 {
10740725 "type": "null"
10840725 }
1094284 ],
1104284 },
1114164 "discount_code": {
1124164 "anyOf": [
1137413 {
1147413 "type": "string"
1157413 },
11640911 {
11740911 "type": "null"
11840911 }
1194164 ],
1204164 },
1214164 "is_business_customer": {
1224164 "anyOf": [
1239411 {
1249411 "type": "boolean"
1259411 },
12640713 {
12740713 "type": "null"
12840713 }
1294164 ],
1304164 },
1314108 "product_id": {
1324108 "anyOf": [
13339523 {
1343954 "format": "uuid4",
13539919 "type": "string"
13639523 },
13715403 {
13815403 "type": "null"
13915403 }
1404108 ],
1414108 },
1424124 "product_price_id": {
1434124 "anyOf": [
14440016 {
1454000 "format": "uuid4",
14640016 "type": "string"
14740016 },
14812404 {
14912404 "type": "null"
15012404 }
1514124 ],
1524124 },
1533937 "seats": {
1543937 "anyOf": [
15538317 {
1563851 "maximum": 1000.0,
1573842 "minimum": 1.0,
15838515 "type": "integer"
15938317 },
16010390 {
16110390 "type": "null"
16210390 }
1633937 ],
1643937 }
165365111 },
1665015 "type": "object"
167390116}
Referenced Components (1)28 of 28 keywords
AddressInput28 of 28 keywords
1269158{
227027 "properties": {
32884 "city": {
42884 "anyOf": [
54288 {
64288 "type": "string"
74288 },
82848 {
92848 "type": "null"
102848 }
112884 ],
122884 },
132906 "country": {
142906 "enum": [
151n/a "AD",
161n/a "AE",
171n/a "AF",
181n/a "AG",
191n/a "AI",
201n/a "AL",
211n/a "AM",
221n/a "AO",
231n/a "AQ",
241n/a "AR",
251n/a "AS",
261n/a "AT",
271n/a "AU",
282n/a "AW",
291n/a "AX",
301n/a "AZ",
311n/a "BA",
321n/a "BB",
331n/a "BD",
341n/a "BE",
351n/a "BF",
361n/a "BG",
371n/a "BH",
381n/a "BI",
391n/a "BJ",
401n/a "BL",
411n/a "BM",
421n/a "BN",
431n/a "BO",
441n/a "BQ",
451n/a "BR",
461n/a "BS",
471n/a "BT",
481n/a "BV",
491n/a "BW",
501n/a "BY",
511n/a "BZ",
521n/a "CA",
531n/a "CC",
541n/a "CD",
551n/a "CF",
561n/a "CG",
571n/a "CH",
581n/a "CI",
591n/a "CK",
601n/a "CL",
611n/a "CM",
621n/a "CN",
631n/a "CO",
641n/a "CR",
651n/a "CV",
661n/a "CW",
671n/a "CX",
681n/a "CY",
691n/a "CZ",
701n/a "DE",
711n/a "DJ",
721n/a "DK",
731n/a "DM",
741n/a "DO",
751n/a "DZ",
761n/a "EC",
771n/a "EE",
781n/a "EG",
791n/a "EH",
801n/a "ER",
811n/a "ES",
821n/a "ET",
831n/a "FI",
841n/a "FJ",
851n/a "FK",
861n/a "FM",
871n/a "FO",
882n/a "FR",
891n/a "GA",
901n/a "GB",
911n/a "GD",
921n/a "GE",
931n/a "GF",
941n/a "GG",
951n/a "GH",
961n/a "GI",
971n/a "GL",
981n/a "GM",
991n/a "GN",
1001n/a "GP",
1011n/a "GQ",
1021n/a "GR",
1031n/a "GS",
1041n/a "GT",
1051n/a "GU",
1061n/a "GW",
1071n/a "GY",
1081n/a "HK",
1091n/a "HM",
1101n/a "HN",
1111n/a "HR",
1121n/a "HT",
1131n/a "HU",
1141n/a "ID",
1151n/a "IE",
1161n/a "IL",
1171n/a "IM",
1181n/a "IN",
1191n/a "IO",
1201n/a "IQ",
1211n/a "IS",
1221n/a "IT",
1231n/a "JE",
1241n/a "JM",
1251n/a "JO",
1261n/a "JP",
1274n/a "KE",
1281n/a "KG",
1291n/a "KH",
1301n/a "KI",
1311n/a "KM",
1321n/a "KN",
1331n/a "KR",
1341n/a "KW",
1351n/a "KY",
1361n/a "KZ",
1371n/a "LA",
1381n/a "LB",
1391n/a "LC",
1401n/a "LI",
1411n/a "LK",
1421n/a "LR",
1431n/a "LS",
1441n/a "LT",
1451n/a "LU",
1461n/a "LV",
1471n/a "LY",
1481n/a "MA",
1491n/a "MC",
1501n/a "MD",
1511n/a "ME",
1521n/a "MF",
1531n/a "MG",
1541n/a "MH",
1551n/a "MK",
1561n/a "ML",
1571n/a "MM",
1581n/a "MN",
1591n/a "MO",
1601n/a "MP",
1611n/a "MQ",
1621n/a "MR",
1631n/a "MS",
1641n/a "MT",
1651n/a "MU",
1661n/a "MV",
1671n/a "MW",
1681n/a "MX",
1691n/a "MY",
1701n/a "MZ",
1711n/a "NA",
1721n/a "NC",
1731n/a "NE",
1741n/a "NF",
1751n/a "NG",
1761n/a "NI",
1771n/a "NL",
1781n/a "NO",
1791n/a "NP",
1801n/a "NR",
1811n/a "NU",
1821n/a "NZ",
1831n/a "OM",
1841n/a "PA",
1851n/a "PE",
1861n/a "PF",
1871n/a "PG",
1881n/a "PH",
1891n/a "PK",
1901n/a "PL",
1911n/a "PM",
1921n/a "PN",
1931n/a "PR",
1941n/a "PS",
1951n/a "PT",
1961n/a "PW",
1971n/a "PY",
1981n/a "QA",
1991n/a "RE",
2001n/a "RO",
2011n/a "RS",
2021n/a "RW",
2031n/a "SA",
2041n/a "SB",
2051n/a "SC",
2061n/a "SD",
2072n/a "SE",
2081n/a "SG",
2091n/a "SH",
2101n/a "SI",
2111n/a "SJ",
2121n/a "SK",
2131n/a "SL",
2141n/a "SM",
2151n/a "SN",
2161n/a "SO",
2171n/a "SR",
2181n/a "SS",
2191n/a "ST",
2201n/a "SV",
2211n/a "SX",
2221n/a "SZ",
2231n/a "TC",
2241n/a "TD",
2251n/a "TF",
2261n/a "TG",
2271n/a "TH",
2281n/a "TJ",
2291n/a "TK",
2301n/a "TL",
2311n/a "TM",
2321n/a "TN",
2331n/a "TO",
2341n/a "TR",
2351n/a "TT",
2361n/a "TV",
2371n/a "TW",
2381n/a "TZ",
2391n/a "UA",
2401n/a "UG",
2411n/a "UM",
24236n/a "US",
2431n/a "UY",
2442n/a "UZ",
2451n/a "VA",
2461n/a "VC",
2471n/a "VE",
2481n/a "VG",
2491n/a "VI",
2505n/a "VN",
2511n/a "VU",
2521n/a "WF",
2531n/a "WS",
2541n/a "YE",
2551n/a "YT",
2561n/a "ZA",
2571n/a "ZM",
2581n/a "ZW"
2592906 ],
2602915 "type": "string",
2612906 },
2622864 "line1": {
2632864 "anyOf": [
2645285 {
2655285 "type": "string"
2665285 },
2672819 {
2682819 "type": "null"
2692819 }
2702864 ],
2712864 },
2722854 "line2": {
2732854 "anyOf": [
2745284 {
2755284 "type": "string"
2765284 },
2772809 {
2782809 "type": "null"
2792809 }
2802854 ],
2812854 },
2822845 "postal_code": {
2832845 "anyOf": [
2845284 {
2855284 "type": "string"
2865284 },
28727910 {
28827910 "type": "null"
28927910 }
2902845 ],
2912845 },
2922854 "state": {
2932854 "anyOf": [
2941288 {
2951288 "type": "string"
2961288 },
2972845 {
2982845 "type": "null"
2992845 }
3002854 ],
3012854 }
30227027 },
3032962 "required": [
3042962 "country"
3052962 ],
306298129 "type": "object"
307269158}
Responses
codedescriptionhitsavg
200Checkout session confirmed.0never seen
400The payment failed.314ms
403The checkout is expired, the customer already has an active subscription, or the organization is not ready to accept payments.1026ms
404Checkout session not found.57903ms
410The checkout session is expired.0never seen
422Validation Error4696ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error5841ms
Examples
Body: application/json
"US"AddressInput.country.examples[0]
"SE"AddressInput.country.examples[1]
"FR"AddressInput.country.examples[2]
"John Doe"CheckoutConfirmStripe.customer_name.examples[0]
Path Parameters
id2 / 2
#validinvalidschema
13909{
23909 "format": "uuid4",
3399n/a "type": "string"
43909}
Responses
codedescriptionhitsavg
200Successful Response30515ms
404Checkout session not found.399ms
422Validation Error96ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized462ms
Path Parameters
id2 / 2
#validinvalidschema
113529{
213529 "format": "uuid4",
31361n/a "type": "string"
413529}
Body
application/json127 / 134
CheckoutUpdate
11001330{
2788320 "properties": {
399611 "allow_discount_codes": {
499611 "anyOf": [
517990 {
617990 "type": "boolean"
717990 },
897928 {
997928 "type": "null"
1097928 }
1199611 ],
1299611 },
139858 "allow_trial": {
149858 "anyOf": [
1513980 {
1613980 "type": "boolean"
1713980 },
1897221 {
1997221 "type": "null"
2097221 }
219858 ],
229858 },
2397516 "amount": {
2497516 "anyOf": [
2595338 {
269592 "maximum": 99999999.0,
279556 "minimum": 50.0,
2895932 "type": "integer"
2995338 },
3022969 {
3122969 "type": "null"
3222969 }
3397516 ],
3497516 },
3597616 "custom_field_data": {
36446 "additionalProperties": {
37946 "anyOf": [
382278 {
392278 "type": "string"
402278 },
411486 {
421486 "type": "integer"
431486 },
441981 {
451981 "type": "boolean"
461981 },
47298 {
48220 "format": "date-time",
492278 "type": "string"
50298 },
513961 {
523961 "type": "null"
533961 }
54946 ]
55446 },
5698210 "type": "object"
5797616 },
5892471 "customer_billing_address": {
5992471 "anyOf": [
60538457 {
62538457 },
63386609 {
64386609 "type": "null"
65386609 }
6692471 ]
6792471 },
689818 "customer_billing_name": {
699818 "anyOf": [
7016973 {
7116973 "type": "string"
7216973 },
7396524 {
7496524 "type": "null"
7596524 }
769818 ],
779818 },
7897312 "customer_email": {
7997312 "anyOf": [
8096322 {
819814 "format": "email",
8296718 "type": "string"
8396322 },
8410975 {
8510975 "type": "null"
8610975 }
8797312 ],
8897312 },
899558 "customer_ip_address": {
909558 "anyOf": [
9194617 {
9200 "format": "ipvanyaddress",
9394617 "type": "string"
9494617 },
959954 {
969954 "type": "null"
979954 }
989558 ],
999558 },
10096615 "customer_metadata": {
10196615 "anyOf": [
10295328 {
103147 "additionalProperties": {
1045019 "anyOf": [
1052544 {
106353 "maxLength": 500,
1072810 "minLength": 1,
1083831 "type": "string"
1092544 },
1101257 {
1111257 "type": "integer"
1121257 },
1131554 {
1141554 "type": "number"
1151554 },
1161059 {
1171059 "type": "boolean"
1181059 }
1195019 ]
120147 },
1219600 "maxProperties": 50,
122174 "propertyNames": {
123672 "maxLength": 40,
124672 "minLength": 1
125174 },
12696021 "type": "object"
12795328 },
12813968 {
12913968 "type": "null"
13013968 }
13196615 ],
13296615 },
13396913 "customer_name": {
13496913 "anyOf": [
13596121 {
1369612 "maxLength": 256,
13796319 "type": "string"
13896121 },
1398974 {
1408974 "type": "null"
1418974 }
14296913 ],
14396913 },
14495013 "customer_tax_id": {
14595013 "anyOf": [
1467956 {
1477956 "type": "string"
1487956 },
14994320 {
15094320 "type": "null"
15194320 }
15295013 ],
15395013 },
15495610 "discount_id": {
15595610 "anyOf": [
15693729 {
1579370 "format": "uuid4",
15893729 "type": "string"
15993729 },
16019947 {
16119947 "type": "null"
16219947 }
16395610 ],
16495610 },
1659568 "embed_origin": {
1669568 "anyOf": [
16716948 {
16816948 "type": "string"
16916948 },
17094024 {
17194024 "type": "null"
17294024 }
1739568 ],
1749568 },
17595310 "is_business_customer": {
17695310 "anyOf": [
1779954 {
1789954 "type": "boolean"
1799954 },
18094419 {
18194419 "type": "null"
18294419 }
18395310 ],
18495310 },
18594515 "metadata": {
186184 "additionalProperties": {
187514 "anyOf": [
1883025 {
189340 "maxLength": 500,
190304 "minLength": 1,
1913421 "type": "string"
1923025 },
193847 {
194847 "type": "integer"
195847 },
1961441 {
1971441 "type": "number"
1981441 },
199748 {
200748 "type": "boolean"
201748 }
202514 ]
203184 },
2049490 "maxProperties": 50,
205184 "propertyNames": {
206532 "maxLength": 40,
207532 "minLength": 1
208184 },
20994911 "type": "object"
21094515 },
2119548 "product_id": {
2129548 "anyOf": [
21394319 {
2149430 "format": "uuid4",
21594319 "type": "string"
21694319 },
21711951 {
21811951 "type": "null"
21911951 }
2209548 ],
2219548 },
2229468 "product_price_id": {
2239468 "anyOf": [
22493222 {
2259320 "format": "uuid4",
22693222 "type": "string"
22793222 },
22814940 {
22914940 "type": "null"
23014940 }
2319468 ],
2329468 },
2339498 "require_billing_address": {
2349498 "anyOf": [
23592730 {
23692730 "type": "boolean"
23792730 },
23822935 {
23922935 "type": "null"
24022935 }
2419498 ],
2429498 },
24393116 "return_url": {
24493116 "anyOf": [
24592225 {
2469246 "format": "uri",
2479282 "maxLength": 2083,
2489282 "minLength": 1,
24993017 "type": "string"
25092225 },
2519938 {
2529938 "type": "null"
2539938 }
25493116 ],
25593116 },
25695214 "seats": {
25795214 "anyOf": [
25894026 {
2599442 "maximum": 1000.0,
2609424 "minimum": 1.0,
26194422 "type": "integer"
26294026 },
26312954 {
26412954 "type": "null"
26512954 }
26695214 ],
26795214 },
26894816 "success_url": {
26994816 "anyOf": [
27093925 {
2719416 "format": "uri",
2729452 "maxLength": 2083,
2739452 "minLength": 1,
27494717 "type": "string"
27593925 },
2769955 {
2779955 "type": "null"
2789955 }
27994816 ],
28094816 },
28193915 "trial_interval": {
28293915 "anyOf": [
28322932 {
28522932 },
28691737 {
28791737 "type": "null"
28891737 }
28993915 ],
29093915 },
29191915 "trial_interval_count": {
29291915 "anyOf": [
29391222 {
2949163 "maximum": 1000.0,
2959154 "minimum": 1.0,
29691717 "type": "integer"
29791222 },
2987927 {
2997927 "type": "null"
3007927 }
30191915 ],
30291915 }
303788320 },
304132110 "type": "object"
3051001330}
Referenced Components (2)31 of 31 keywords
AddressInput28 of 28 keywords
1538457{
254059 "properties": {
35748 "city": {
45748 "anyOf": [
56576 {
66576 "type": "string"
76576 },
856814 {
956814 "type": "null"
1056814 }
115748 ],
125748 },
1358313 "country": {
1458313 "enum": [
158n/a "AD",
164n/a "AE",
172n/a "AF",
182n/a "AG",
192n/a "AI",
202n/a "AL",
212n/a "AM",
222n/a "AO",
232n/a "AQ",
242n/a "AR",
252n/a "AS",
262n/a "AT",
272n/a "AU",
282n/a "AW",
292n/a "AX",
302n/a "AZ",
312n/a "BA",
322n/a "BB",
332n/a "BD",
342n/a "BE",
352n/a "BF",
362n/a "BG",
372n/a "BH",
382n/a "BI",
392n/a "BJ",
402n/a "BL",
412n/a "BM",
422n/a "BN",
432n/a "BO",
442n/a "BQ",
452n/a "BR",
462n/a "BS",
472n/a "BT",
482n/a "BV",
492n/a "BW",
502n/a "BY",
512n/a "BZ",
522n/a "CA",
532n/a "CC",
542n/a "CD",
552n/a "CF",
562n/a "CG",
572n/a "CH",
582n/a "CI",
593n/a "CK",
603n/a "CL",
612n/a "CM",
622n/a "CN",
632n/a "CO",
643n/a "CR",
652n/a "CV",
662n/a "CW",
672n/a "CX",
682n/a "CY",
692n/a "CZ",
704n/a "DE",
712n/a "DJ",
722n/a "DK",
732n/a "DM",
742n/a "DO",
752n/a "DZ",
762n/a "EC",
772n/a "EE",
782n/a "EG",
792n/a "EH",
802n/a "ER",
812n/a "ES",
822n/a "ET",
832n/a "FI",
842n/a "FJ",
852n/a "FK",
862n/a "FM",
872n/a "FO",
883n/a "FR",
892n/a "GA",
902n/a "GB",
912n/a "GD",
922n/a "GE",
932n/a "GF",
943n/a "GG",
952n/a "GH",
962n/a "GI",
972n/a "GL",
982n/a "GM",
992n/a "GN",
1002n/a "GP",
1012n/a "GQ",
1022n/a "GR",
1032n/a "GS",
1042n/a "GT",
1052n/a "GU",
1062n/a "GW",
1072n/a "GY",
1082n/a "HK",
1092n/a "HM",
1102n/a "HN",
1112n/a "HR",
1122n/a "HT",
1132n/a "HU",
1142n/a "ID",
1152n/a "IE",
1162n/a "IL",
1172n/a "IM",
1182n/a "IN",
1192n/a "IO",
1202n/a "IQ",
1212n/a "IS",
1222n/a "IT",
1232n/a "JE",
1242n/a "JM",
1252n/a "JO",
1262n/a "JP",
1272n/a "KE",
1282n/a "KG",
1292n/a "KH",
1302n/a "KI",
1312n/a "KM",
1322n/a "KN",
1332n/a "KR",
1342n/a "KW",
1352n/a "KY",
1362n/a "KZ",
1372n/a "LA",
1382n/a "LB",
1392n/a "LC",
1402n/a "LI",
1412n/a "LK",
1422n/a "LR",
1432n/a "LS",
1442n/a "LT",
1452n/a "LU",
1462n/a "LV",
1472n/a "LY",
1482n/a "MA",
1492n/a "MC",
1502n/a "MD",
1512n/a "ME",
1522n/a "MF",
1532n/a "MG",
1542n/a "MH",
1552n/a "MK",
1562n/a "ML",
1572n/a "MM",
1582n/a "MN",
1592n/a "MO",
1602n/a "MP",
1612n/a "MQ",
1622n/a "MR",
1636n/a "MS",
1642n/a "MT",
1652n/a "MU",
1662n/a "MV",
1672n/a "MW",
1682n/a "MX",
1694n/a "MY",
1702n/a "MZ",
1712n/a "NA",
1722n/a "NC",
1732n/a "NE",
1742n/a "NF",
1752n/a "NG",
1762n/a "NI",
1772n/a "NL",
1782n/a "NO",
1792n/a "NP",
1802n/a "NR",
1812n/a "NU",
1822n/a "NZ",
1832n/a "OM",
1842n/a "PA",
1852n/a "PE",
1862n/a "PF",
1872n/a "PG",
1882n/a "PH",
1892n/a "PK",
1902n/a "PL",
1912n/a "PM",
1922n/a "PN",
1932n/a "PR",
1942n/a "PS",
1952n/a "PT",
1962n/a "PW",
1972n/a "PY",
1982n/a "QA",
1992n/a "RE",
2002n/a "RO",
2012n/a "RS",
2022n/a "RW",
2032n/a "SA",
2042n/a "SB",
2052n/a "SC",
2062n/a "SD",
2073n/a "SE",
2082n/a "SG",
2092n/a "SH",
2102n/a "SI",
2115n/a "SJ",
2122n/a "SK",
2132n/a "SL",
2142n/a "SM",
2152n/a "SN",
2162n/a "SO",
2172n/a "SR",
2182n/a "SS",
2192n/a "ST",
2202n/a "SV",
2212n/a "SX",
2222n/a "SZ",
2232n/a "TC",
2242n/a "TD",
2252n/a "TF",
2262n/a "TG",
2272n/a "TH",
2282n/a "TJ",
2292n/a "TK",
2302n/a "TL",
2312n/a "TM",
2322n/a "TN",
2332n/a "TO",
2342n/a "TR",
2352n/a "TT",
2362n/a "TV",
2372n/a "TW",
2382n/a "TZ",
2392n/a "UA",
2402n/a "UG",
2412n/a "UM",
24271n/a "US",
2432n/a "UY",
2442n/a "UZ",
2452n/a "VA",
2462n/a "VC",
2472n/a "VE",
2482n/a "VG",
2492n/a "VI",
2502n/a "VN",
2512n/a "VU",
2522n/a "WF",
2532n/a "WS",
2542n/a "YE",
2552n/a "YT",
2563n/a "ZA",
2572n/a "ZM",
2582n/a "ZW"
25958313 ],
26058610 "type": "string",
26158313 },
26257313 "line1": {
26357313 "anyOf": [
2645581 {
2655581 "type": "string"
2665581 },
26756818 {
26856818 "type": "null"
26956818 }
27057313 ],
27157313 },
2725678 "line2": {
2735678 "anyOf": [
2746569 {
2756569 "type": "string"
2766569 },
27756114 {
27856114 "type": "null"
27956114 }
2805678 ],
2815678 },
2825679 "postal_code": {
2835679 "anyOf": [
2844572 {
2854572 "type": "string"
2864572 },
28756313 {
28856313 "type": "null"
28956313 }
2905679 ],
2915679 },
2925638 "state": {
2935638 "anyOf": [
2948563 {
2958563 "type": "string"
2968563 },
29755516 {
29855516 "type": "null"
29955516 }
3005638 ],
3015638 }
30254059 },
3035965 "required": [
3045965 "country"
3055965 ],
306601394 "type": "object"
307538457}
TrialInterval3 of 3 keywords
122932{
222932 "enum": [
37n/a "day",
45n/a "week",
55n/a "month",
65n/a "year"
722932 ],
825929 "type": "string"
922932}
Responses
codedescriptionhitsavg
200Checkout session updated.25337ms
403The checkout is expired, the customer already has an active subscription, or the organization is not ready to accept payments.0never seen
404Checkout session not found.1110ms
422Validation Error10366ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error38961ms
401Unauthorized183ms
400Bad Request55ms
Examples
Body: application/json
"US"AddressInput.country.examples[0]
"SE"AddressInput.country.examples[1]
"FR"AddressInput.country.examples[2]
"John Doe"CheckoutUpdate.customer_name.examples[0]
custom-fields 5 operations 1 covered 4 partial 0 uncovered 0 not measured 92% #
Query Parameters
organization_id2 / 7
#validinvalidschema
14390{
24390 "anyOf": [
30439 {
400 "format": "uuid4",
50n/a "type": "string",
60439 },
74390 {
84390 "items": {
94390 "format": "uuid4",
10439n/a "type": "string",
114390 },
124390 "type": "array"
134390 },
140439 {
150439 "type": "null"
160439 }
174390 ],
184390}
query3 / 3
1142n/a{
2142n/a "anyOf": [
3119n/a {
4119n/a "type": "string"
5119n/a },
623119 {
723119 "type": "null"
823119 }
9142n/a ],
10142n/a}
type4 / 7
111171{
211171 "anyOf": [
30182 {
50182 },
611171 {
711171 "items": {
911171 },
101820 "type": "array"
1111171 },
120182 {
130182 "type": "null"
140182 }
1511171 ],
1611171}
Referenced Components (1)3 of 3 keywords
CustomFieldType3 of 3 keywords
1335278{
2335278 "enum": [
397n/a "text",
468n/a "number",
557n/a "date",
664n/a "checkbox",
749n/a "select"
8335278 ],
9373n/a "type": "string"
10335278}
page2 / 2
120326{
220311 "exclusiveMinimum": 0,
321415 "type": "integer"
420326}
limit2 / 2
119847{
219816 "exclusiveMinimum": 0,
321431 "type": "integer"
419847}
sorting4 / 6
110667{
210667 "anyOf": [
310667 {
410667 "items": {
610667 },
71730 "type": "array"
810667 },
90173 {
100173 "type": "null"
110173 }
1210667 ],
1310667}
Referenced Components (1)3 of 3 keywords
CustomFieldSortProperty3 of 3 keywords
140783{
240783 "enum": [
344n/a "created_at",
444n/a "-created_at",
588n/a "slug",
650n/a "-slug",
752n/a "name",
845n/a "-name",
942n/a "type",
1042n/a "-type"
1140783 ],
12426n/a "type": "string"
1340783}
Responses
codedescriptionhitsavg
200Successful Response1868ms
422Validation Error1186ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized163ms
500Internal Server Error1191013ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "slug" ]sorting
Body
application/json186 / 196
CustomFieldCreate
#validinvalidschema
1635759{
2635759 "oneOf": [
31441250 {
51441250 },
61151279 {
81151279 },
91451249 {
111451249 },
121231271 {
141231271 },
151081286 {
171081286 }
18635759 ]
19635759}
Referenced Components (11)208 of 218 keywords
CustomFieldCheckboxProperties9 of 9 keywords
11107240{
2947189 "properties": {
3101162 "form_help_text": {
4101111 "minLength": 1,
5102251 "type": "string"
6101162 },
790368 "form_label": {
890317 "minLength": 1,
992051 "type": "string"
1090368 },
1189660 "form_placeholder": {
1289610 "minLength": 1,
1390650 "type": "string"
1489660 }
15947189 },
16129651 "type": "object"
171107240}
CustomFieldCreateCheckbox28 of 30 keywords
11231271{
21491232 "properties": {
3101979 "metadata": {
413829 "additionalProperties": {
548951 "anyOf": [
6122418 {
71474 "maxLength": 500,
812625 "minLength": 1,
9151389 "type": "string"
10122418 },
1198442 {
1298442 "type": "integer"
1398442 },
14128412 {
15128412 "type": "number"
16128412 },
17239301 {
18239301 "type": "boolean"
19239301 }
2048951 ]
2113829 },
2210480 "maxProperties": 50,
2314720 "propertyNames": {
2453010 "maxLength": 40,
2553010 "minLength": 1
2614720 },
27104850 "type": "object"
28101979 },
29128860 "name": {
30128810 "minLength": 1,
31129850 "type": "string"
32128860 },
33130940 "organization_id": {
34130940 "anyOf": [
35129950 {
3612990 "format": "uuid4",
37129950 "type": "string",
38129950 },
39101339 {
40101339 "type": "null"
41101339 }
42130940 ],
43130940 },
441107240 "properties": {
461107240 },
47127671 "slug": {
48128710 "minLength": 1,
49127621 "pattern": "^[a-z0-9-_]+$",
50129750 "type": "string"
51127671 },
522251136 "type": {
532251136 "const": "checkbox",
54131150 "type": "string"
552251136 }
561491232 },
57131962 "required": [
58136120 "type",
59134734 "slug",
60134833 "name",
61134734 "properties"
62131962 ],
63138113 "type": "object"
641231271}
CustomFieldCreateDate28 of 30 keywords
11451249{
21711210 "properties": {
3101979 "metadata": {
413829 "additionalProperties": {
548951 "anyOf": [
6122418 {
71474 "maxLength": 500,
812625 "minLength": 1,
9151389 "type": "string"
10122418 },
1198442 {
1298442 "type": "integer"
1398442 },
14128412 {
15128412 "type": "number"
16128412 },
17239301 {
18239301 "type": "boolean"
19239301 }
2048951 ]
2113829 },
2210480 "maxProperties": 50,
2314720 "propertyNames": {
2453010 "maxLength": 40,
2553010 "minLength": 1
2614720 },
27104850 "type": "object"
28101979 },
29128860 "name": {
30128810 "minLength": 1,
31129850 "type": "string"
32128860 },
33130940 "organization_id": {
34130940 "anyOf": [
35129950 {
3612990 "format": "uuid4",
37129950 "type": "string",
38129950 },
39101339 {
40101339 "type": "null"
41101339 }
42130940 ],
43130940 },
441059288 "properties": {
461059288 },
47127671 "slug": {
48128710 "minLength": 1,
49127621 "pattern": "^[a-z0-9-_]+$",
50129750 "type": "string"
51127671 },
522761085 "type": {
532761085 "const": "date",
54131150 "type": "string"
552761085 }
561711210 },
57131962 "required": [
58136120 "type",
59134734 "slug",
60134833 "name",
61134734 "properties"
62131962 ],
63138113 "type": "object"
641451249}
CustomFieldCreateNumber28 of 30 keywords
11151279{
21411240 "properties": {
3101979 "metadata": {
413829 "additionalProperties": {
548951 "anyOf": [
6122418 {
71474 "maxLength": 500,
812625 "minLength": 1,
9151389 "type": "string"
10122418 },
1198442 {
1298442 "type": "integer"
1398442 },
14128412 {
15128412 "type": "number"
16128412 },
17239301 {
18239301 "type": "boolean"
19239301 }
2048951 ]
2113829 },
2210480 "maxProperties": 50,
2314720 "propertyNames": {
2453010 "maxLength": 40,
2553010 "minLength": 1
2614720 },
27104850 "type": "object"
28101979 },
29128860 "name": {
30128810 "minLength": 1,
31129850 "type": "string"
32128860 },
33130940 "organization_id": {
34130940 "anyOf": [
35129950 {
3612990 "format": "uuid4",
37129950 "type": "string",
38129950 },
39101339 {
40101339 "type": "null"
41101339 }
42130940 ],
43130940 },
441059288 "properties": {
461059288 },
47127671 "slug": {
48128710 "minLength": 1,
49127621 "pattern": "^[a-z0-9-_]+$",
50129750 "type": "string"
51127671 },
522391122 "type": {
532391122 "const": "number",
54131150 "type": "string"
552391122 }
561411240 },
57131962 "required": [
58136120 "type",
59134734 "slug",
60134833 "name",
61134734 "properties"
62131962 ],
63138113 "type": "object"
641151279}
CustomFieldCreateSelect28 of 30 keywords
11081286{
21281253 "properties": {
3101979 "metadata": {
413829 "additionalProperties": {
548951 "anyOf": [
6122418 {
71474 "maxLength": 500,
812625 "minLength": 1,
9151389 "type": "string"
10122418 },
1198442 {
1298442 "type": "integer"
1398442 },
14128412 {
15128412 "type": "number"
16128412 },
17239301 {
18239301 "type": "boolean"
19239301 }
2048951 ]
2113829 },
2210480 "maxProperties": 50,
2314720 "propertyNames": {
2453010 "maxLength": 40,
2553010 "minLength": 1
2614720 },
27104850 "type": "object"
28101979 },
29128860 "name": {
30128810 "minLength": 1,
31129850 "type": "string"
32128860 },
33130940 "organization_id": {
34130940 "anyOf": [
35129950 {
3612990 "format": "uuid4",
37129950 "type": "string",
38129950 },
39101339 {
40101339 "type": "null"
41101339 }
42130940 ],
43130940 },
441751172 "properties": {
461751172 },
47127671 "slug": {
48128710 "minLength": 1,
49127621 "pattern": "^[a-z0-9-_]+$",
50129750 "type": "string"
51127671 },
522691092 "type": {
532691092 "const": "select",
54131150 "type": "string"
552691092 }
561281253 },
57131962 "required": [
58136120 "type",
59134734 "slug",
60134833 "name",
61134734 "properties"
62131962 ],
63138113 "type": "object"
641081286}
CustomFieldCreateText28 of 30 keywords
11441250{
21701211 "properties": {
3101979 "metadata": {
413829 "additionalProperties": {
548951 "anyOf": [
6122418 {
71474 "maxLength": 500,
812625 "minLength": 1,
9151389 "type": "string"
10122418 },
1198442 {
1298442 "type": "integer"
1398442 },
14128412 {
15128412 "type": "number"
16128412 },
17239301 {
18239301 "type": "boolean"
19239301 }
2048951 ]
2113829 },
2210480 "maxProperties": 50,
2314720 "propertyNames": {
2453010 "maxLength": 40,
2553010 "minLength": 1
2614720 },
27104850 "type": "object"
28101979 },
29128860 "name": {
30128810 "minLength": 1,
31129850 "type": "string"
32128860 },
33130940 "organization_id": {
34130940 "anyOf": [
35129950 {
3612990 "format": "uuid4",
37129950 "type": "string",
38129950 },
39101339 {
40101339 "type": "null"
41101339 }
42130940 ],
43130940 },
441067280 "properties": {
461067280 },
47127671 "slug": {
48128710 "minLength": 1,
49127621 "pattern": "^[a-z0-9-_]+$",
50129750 "type": "string"
51127671 },
522921069 "type": {
532921069 "const": "text",
54131150 "type": "string"
552921069 }
561701211 },
57131962 "required": [
58136120 "type",
59134734 "slug",
60134833 "name",
61134734 "properties"
62131962 ],
63138113 "type": "object"
641441250}
CustomFieldDateProperties11 of 11 keywords
11059288{
2944237 "properties": {
3101162 "form_help_text": {
4101111 "minLength": 1,
5102251 "type": "string"
6101162 },
790368 "form_label": {
890317 "minLength": 1,
992051 "type": "string"
1090368 },
1189660 "form_placeholder": {
1289610 "minLength": 1,
1390650 "type": "string"
1489660 },
1533331 "ge": {
1633331 "type": "integer"
1733331 },
1830424 "le": {
1930424 "type": "integer"
2030424 }
21944237 },
22129651 "type": "object"
231059288}
CustomFieldNumberProperties11 of 11 keywords
11059288{
2944237 "properties": {
3101162 "form_help_text": {
4101111 "minLength": 1,
5102251 "type": "string"
6101162 },
790368 "form_label": {
890317 "minLength": 1,
992051 "type": "string"
1090368 },
1189660 "form_placeholder": {
1289610 "minLength": 1,
1390650 "type": "string"
1489660 },
1533331 "ge": {
1633331 "type": "integer"
1733331 },
1830424 "le": {
1930424 "type": "integer"
2030424 }
21944237 },
22129651 "type": "object"
231059288}
CustomFieldSelectOption9 of 9 keywords
139363{
239749 "properties": {
343212 "label": {
44322 "minLength": 1,
543410 "type": "string"
643212 },
740737 "value": {
840727 "minLength": 1,
943410 "type": "string"
1040737 }
1139749 },
124424 "required": [
134442 "value",
144442 "label"
154424 ],
1644610 "type": "object"
1739363}
CustomFieldSelectProperties14 of 14 keywords
11751172{
2902247 "properties": {
3101162 "form_help_text": {
4101111 "minLength": 1,
5102251 "type": "string"
6101162 },
790368 "form_label": {
890317 "minLength": 1,
992051 "type": "string"
1090368 },
1189660 "form_placeholder": {
1289610 "minLength": 1,
1390650 "type": "string"
1489660 },
1521158 "options": {
1621345 "items": {
1821345 },
192562 "minItems": 1,
2025811 "type": "array"
2121158 }
22902247 },
232691027 "required": [
242691027 "options"
252691027 ],
26129651 "type": "object"
271751172}
CustomFieldTextProperties14 of 14 keywords
11067280{
2921229 "properties": {
3101162 "form_help_text": {
4101111 "minLength": 1,
5102251 "type": "string"
6101162 },
790368 "form_label": {
890317 "minLength": 1,
992051 "type": "string"
1090368 },
1189660 "form_placeholder": {
1289610 "minLength": 1,
1390650 "type": "string"
1489660 },
1518415 "max_length": {
161863 "minimum": 0.0,
1718712 "type": "integer"
1818415 },
1917615 "min_length": {
201783 "minimum": 0.0,
2117912 "type": "integer"
2217615 },
2317510 "textarea": {
2417510 "type": "boolean"
2517510 }
26921229 },
27129651 "type": "object"
281067280}
Responses
codedescriptionhitsavg
201Custom field created.8115ms
422Validation Error13056ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized393ms
400Bad Request95ms
500Internal Server Error61985ms
Examples
Body: application/json
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"CustomFieldCreateText.organization_id.examples[0]
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"CustomFieldCreateNumber.organization_id.examples[0]
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"CustomFieldCreateDate.organization_id.examples[0]
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"CustomFieldCreateCheckbox.organization_id.examples[0]
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"CustomFieldCreateSelect.organization_id.examples[0]
Path Parameters
id1 / 2
#validinvalidschema
1200{
2200 "format": "uuid4",
320n/a "type": "string"
4200}
Responses
codedescriptionhitsavg
204Custom field deleted.1515ms
404Custom field not found.26ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized33ms
Path Parameters
id2 / 2
#validinvalidschema
137831{
237831 "format": "uuid4",
3409n/a "type": "string"
437831}
Responses
codedescriptionhitsavg
200Successful Response3057ms
404Custom field not found.347ms
422Validation Error316ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized283ms
500Internal Server Error11694ms
Path Parameters
id2 / 2
#validinvalidschema
17431{
27431 "format": "uuid4",
3744n/a "type": "string"
47431}
Body
application/json196 / 206
CustomFieldUpdate
1412306{
2412306 "oneOf": [
3253465 {
5253465 },
640678 {
840678 },
942676 {
1142676 },
1246672 {
1446672 },
1531687 {
1731687 }
18412306 ]
19412306}
Referenced Components (11)228 of 238 keywords
CustomFieldCheckboxProperties9 of 9 keywords
1147275{
213393 "properties": {
318133 "form_help_text": {
41816 "minLength": 1,
518727 "type": "string"
618133 },
718032 "form_label": {
81805 "minLength": 1,
918527 "type": "string"
1018032 },
1117231 "form_placeholder": {
121726 "minLength": 1,
1317825 "type": "string"
1417231 }
1513393 },
16240182 "type": "object"
17147275}
CustomFieldDateProperties11 of 11 keywords
1123299{
2113117 "properties": {
318133 "form_help_text": {
41816 "minLength": 1,
518727 "type": "string"
618133 },
718032 "form_label": {
81805 "minLength": 1,
918527 "type": "string"
1018032 },
1117231 "form_placeholder": {
121726 "minLength": 1,
1317825 "type": "string"
1417231 },
156812 "ge": {
166812 "type": "integer"
176812 },
186712 "le": {
196712 "type": "integer"
206712 }
21113117 },
22240182 "type": "object"
23123299}
CustomFieldNumberProperties11 of 11 keywords
1123299{
2113117 "properties": {
318133 "form_help_text": {
41816 "minLength": 1,
518727 "type": "string"
618133 },
718032 "form_label": {
81805 "minLength": 1,
918527 "type": "string"
1018032 },
1117231 "form_placeholder": {
121726 "minLength": 1,
1317825 "type": "string"
1417231 },
156812 "ge": {
166812 "type": "integer"
176812 },
186712 "le": {
196712 "type": "integer"
206712 }
21113117 },
22240182 "type": "object"
23123299}
CustomFieldSelectOption9 of 9 keywords
13219{
23412 "properties": {
3396 "label": {
4391 "minLength": 1,
5405 "type": "string"
6396 },
7396 "value": {
8391 "minLength": 1,
9405 "type": "string"
10396 }
113412 },
12442 "required": [
13451 "value",
14451 "label"
15442 ],
16465 "type": "object"
173219}
CustomFieldSelectProperties14 of 14 keywords
113409{
2109118 "properties": {
318133 "form_help_text": {
41816 "minLength": 1,
518727 "type": "string"
618133 },
718032 "form_label": {
81805 "minLength": 1,
918527 "type": "string"
1018032 },
1117231 "form_placeholder": {
121726 "minLength": 1,
1317825 "type": "string"
1417231 },
153125 "options": {
163219 "items": {
183219 },
19501 "minItems": 1,
20515 "type": "array"
213125 }
22109118 },
2356184 "required": [
2456184 "options"
2556184 ],
26240182 "type": "object"
2713409}
CustomFieldTextProperties14 of 14 keywords
1128294{
2117112 "properties": {
318133 "form_help_text": {
41816 "minLength": 1,
518727 "type": "string"
618133 },
718032 "form_label": {
81805 "minLength": 1,
918527 "type": "string"
1018032 },
1117231 "form_placeholder": {
121726 "minLength": 1,
1317825 "type": "string"
1417231 },
15427 "max_length": {
16431 "minimum": 0.0,
17436 "type": "integer"
18427 },
19397 "min_length": {
20401 "minimum": 0.0,
21406 "type": "integer"
22397 },
23405 "textarea": {
24405 "type": "boolean"
25405 }
26117112 },
27240182 "type": "object"
28128294}
CustomFieldUpdateCheckbox32 of 34 keywords
146672{
247666 "properties": {
340245 "metadata": {
42520 "additionalProperties": {
59441 "anyOf": [
628107 {
7380 "maxLength": 500,
82810 "minLength": 1,
93897 "type": "string"
1028107 },
1115120 {
1215120 "type": "integer"
1315120 },
1429106 {
1529106 "type": "number"
1629106 },
173798 {
183798 "type": "boolean"
193798 }
209441 ]
212520 },
224220 "maxProperties": 50,
233510 "propertyNames": {
241305 "maxLength": 40,
251305 "minLength": 1
263510 },
2742225 "type": "object"
2840245 },
2940725 "name": {
3040725 "anyOf": [
3139141 {
323915 "minLength": 1,
3339636 "type": "string"
3439141 },
3516416 {
3616416 "type": "null"
3716416 }
3840725 ],
3940725 },
40309113 "properties": {
41309113 "anyOf": [
42147275 {
44147275 },
45162260 {
46162260 "type": "null"
47162260 }
48309113 ]
49309113 },
5037140 "slug": {
5137140 "anyOf": [
5235853 {
533685 "minLength": 1,
5435815 "pattern": "^[a-z0-9-_]+$",
5537338 "type": "string"
5635853 },
5713398 {
5813398 "type": "null"
5913398 }
6037140 ],
6137140 },
6287625 "type": {
6387625 "const": "checkbox",
6470210 "type": "string"
6587625 }
6647666 },
677121 "required": [
687121 "type"
697121 ],
707135 "type": "object"
7146672}
CustomFieldUpdateDate32 of 34 keywords
142676{
243670 "properties": {
340245 "metadata": {
42520 "additionalProperties": {
59441 "anyOf": [
628107 {
7380 "maxLength": 500,
82810 "minLength": 1,
93897 "type": "string"
1028107 },
1115120 {
1215120 "type": "integer"
1315120 },
1429106 {
1529106 "type": "number"
1629106 },
173798 {
183798 "type": "boolean"
193798 }
209441 ]
212520 },
224220 "maxProperties": 50,
233510 "propertyNames": {
241305 "maxLength": 40,
251305 "minLength": 1
263510 },
2742225 "type": "object"
2840245 },
2940725 "name": {
3040725 "anyOf": [
3139141 {
323915 "minLength": 1,
3339636 "type": "string"
3439141 },
3516416 {
3616416 "type": "null"
3716416 }
3840725 ],
3940725 },
40285137 "properties": {
41285137 "anyOf": [
42123299 {
44123299 },
45162260 {
46162260 "type": "null"
47162260 }
48285137 ]
49285137 },
5037140 "slug": {
5137140 "anyOf": [
5235853 {
533685 "minLength": 1,
5435815 "pattern": "^[a-z0-9-_]+$",
5537338 "type": "string"
5635853 },
5713398 {
5813398 "type": "null"
5913398 }
6037140 ],
6137140 },
6295617 "type": {
6395617 "const": "date",
6470210 "type": "string"
6595617 }
6643670 },
677121 "required": [
687121 "type"
697121 ],
707135 "type": "object"
7142676}
CustomFieldUpdateNumber32 of 34 keywords
140678{
241672 "properties": {
340245 "metadata": {
42520 "additionalProperties": {
59441 "anyOf": [
628107 {
7380 "maxLength": 500,
82810 "minLength": 1,
93897 "type": "string"
1028107 },
1115120 {
1215120 "type": "integer"
1315120 },
1429106 {
1529106 "type": "number"
1629106 },
173798 {
183798 "type": "boolean"
193798 }
209441 ]
212520 },
224220 "maxProperties": 50,
233510 "propertyNames": {
241305 "maxLength": 40,
251305 "minLength": 1
263510 },
2742225 "type": "object"
2840245 },
2940725 "name": {
3040725 "anyOf": [
3139141 {
323915 "minLength": 1,
3339636 "type": "string"
3439141 },
3516416 {
3616416 "type": "null"
3716416 }
3840725 ],
3940725 },
40285137 "properties": {
41285137 "anyOf": [
42123299 {
44123299 },
45162260 {
46162260 "type": "null"
47162260 }
48285137 ]
49285137 },
5037140 "slug": {
5137140 "anyOf": [
5235853 {
533685 "minLength": 1,
5435815 "pattern": "^[a-z0-9-_]+$",
5537338 "type": "string"
5635853 },
5713398 {
5813398 "type": "null"
5913398 }
6037140 ],
6137140 },
62103609 "type": {
63103609 "const": "number",
6470210 "type": "string"
65103609 }
6641672 },
677121 "required": [
687121 "type"
697121 ],
707135 "type": "object"
7140678}
CustomFieldUpdateSelect32 of 34 keywords
131687{
232681 "properties": {
340245 "metadata": {
42520 "additionalProperties": {
59441 "anyOf": [
628107 {
7380 "maxLength": 500,
82810 "minLength": 1,
93897 "type": "string"
1028107 },
1115120 {
1215120 "type": "integer"
1315120 },
1429106 {
1529106 "type": "number"
1629106 },
173798 {
183798 "type": "boolean"
193798 }
209441 ]
212520 },
224220 "maxProperties": 50,
233510 "propertyNames": {
241305 "maxLength": 40,
251305 "minLength": 1
263510 },
2742225 "type": "object"
2840245 },
2940725 "name": {
3040725 "anyOf": [
3139141 {
323915 "minLength": 1,
3339636 "type": "string"
3439141 },
3516416 {
3616416 "type": "null"
3716416 }
3840725 ],
3940725 },
40175247 "properties": {
41175247 "anyOf": [
4213409 {
4413409 },
45162260 {
46162260 "type": "null"
47162260 }
48175247 ]
49175247 },
5037140 "slug": {
5137140 "anyOf": [
5235853 {
533685 "minLength": 1,
5435815 "pattern": "^[a-z0-9-_]+$",
5537338 "type": "string"
5635853 },
5713398 {
5813398 "type": "null"
5913398 }
6037140 ],
6137140 },
62100612 "type": {
63100612 "const": "select",
6470210 "type": "string"
65100612 }
6632681 },
677121 "required": [
687121 "type"
697121 ],
707135 "type": "object"
7131687}
CustomFieldUpdateText32 of 34 keywords
1253465{
2254459 "properties": {
340245 "metadata": {
42520 "additionalProperties": {
59441 "anyOf": [
628107 {
7380 "maxLength": 500,
82810 "minLength": 1,
93897 "type": "string"
1028107 },
1115120 {
1215120 "type": "integer"
1315120 },
1429106 {
1529106 "type": "number"
1629106 },
173798 {
183798 "type": "boolean"
193798 }
209441 ]
212520 },
224220 "maxProperties": 50,
233510 "propertyNames": {
241305 "maxLength": 40,
251305 "minLength": 1
263510 },
2742225 "type": "object"
2840245 },
2940725 "name": {
3040725 "anyOf": [
3139141 {
323915 "minLength": 1,
3339636 "type": "string"
3439141 },
3516416 {
3616416 "type": "null"
3716416 }
3840725 ],
3940725 },
40290132 "properties": {
41290132 "anyOf": [
42128294 {
44128294 },
45162260 {
46162260 "type": "null"
47162260 }
48290132 ]
49290132 },
5037140 "slug": {
5137140 "anyOf": [
5235853 {
533685 "minLength": 1,
5435815 "pattern": "^[a-z0-9-_]+$",
5537338 "type": "string"
5635853 },
5713398 {
5813398 "type": "null"
5913398 }
6037140 ],
6137140 },
62315397 "type": {
63315397 "const": "text",
6470210 "type": "string"
65315397 }
66254459 },
677121 "required": [
687121 "type"
697121 ],
707135 "type": "object"
71253465}
Responses
codedescriptionhitsavg
200Custom field updated.1207ms
404Custom field not found.1476ms
422Validation Error4526ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized83ms
500Internal Server Error81421ms
400Bad Request96ms
customer_meters 2 operations 1 covered 1 partial 0 uncovered 0 not measured 47% #
Query Parameters
organization_id2 / 7
#validinvalidschema
15850{
25850 "anyOf": [
30585 {
400 "format": "uuid4",
50n/a "type": "string",
60585 },
75850 {
85850 "items": {
95850 "format": "uuid4",
10585n/a "type": "string",
115850 },
125850 "type": "array"
135850 },
140585 {
150585 "type": "null"
160585 }
175850 ],
185850}
customer_id4 / 7
13073{
23073 "anyOf": [
30310 {
400 "format": "uuid4",
50n/a "type": "string"
60310 },
73073 {
83073 "items": {
96431 "format": "uuid4",
10644n/a "type": "string"
113073 },
123100 "type": "array"
133073 },
140310 {
150310 "type": "null"
160310 }
173073 ],
183073}
external_customer_id3 / 5
1233n/a{
2233n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
623352 {
7233n/a "items": {
8498n/a "type": "string"
9233n/a },
102850 "type": "array"
1123352 },
120285 {
130285 "type": "null"
140285 }
15233n/a ],
16233n/a}
meter_id3 / 7
14911{
24911 "anyOf": [
30492 {
400 "format": "uuid4",
50n/a "type": "string"
60492 },
74911 {
84911 "items": {
95730 "format": "uuid4",
10573n/a "type": "string"
114911 },
124920 "type": "array"
134911 },
140492 {
150492 "type": "null"
160492 }
174911 ],
184911}
page2 / 2
126620{
22662 "exclusiveMinimum": 0,
326818 "type": "integer"
426620}
limit2 / 2
134518{
23452 "exclusiveMinimum": 0,
334716 "type": "integer"
434518}
sorting4 / 6
121911{
221911 "anyOf": [
321911 {
421911 "items": {
621911 },
72300 "type": "array"
821911 },
90230 {
100230 "type": "null"
110230 }
1221911 ],
1321911}
Referenced Components (1)3 of 3 keywords
CustomerMeterSortProperty3 of 3 keywords
1140413{
2140413 "enum": [
327n/a "created_at",
422n/a "-created_at",
5126n/a "modified_at",
678n/a "-modified_at",
730n/a "customer_id",
860n/a "-customer_id",
9153n/a "customer_name",
1042n/a "-customer_name",
1124n/a "meter_id",
1253n/a "-meter_id",
1339n/a "meter_name",
1438n/a "-meter_name",
1574n/a "consumed_units",
1679n/a "-consumed_units",
1781n/a "credited_units",
1883n/a "-credited_units",
19361n/a "balance",
2034n/a "-balance"
21140413 ],
221406n/a "type": "string"
23140413}
Responses
codedescriptionhitsavg
200Successful Response3398ms
422Validation Error375ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2002ms
500Internal Server Error91472ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-modified_at" ]sorting
Path Parameters
id2 / 2
#validinvalidschema
135156{
235156 "format": "uuid4",
3407n/a "type": "string"
435156}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Customer meter not found.3077ms
422Validation Error565ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized442ms
customer_portal 43 operations 29 covered 14 partial 0 uncovered 0 not measured 83% #
Query Parameters
type4 / 7
#validinvalidschema
119717{
219717 "anyOf": [
30214 {
50214 },
619717 {
719717 "items": {
919717 },
102140 "type": "array"
1119717 },
120214 {
130214 "type": "null"
140214 }
1519717 ],
1619717}
Referenced Components (1)3 of 3 keywords
BenefitType3 of 3 keywords
1526233{
2526233 "enum": [
3157n/a "custom",
498n/a "discord",
573n/a "github_repository",
647n/a "downloadables",
774n/a "license_keys",
877n/a "meter_credit"
9526233 ],
10532n/a "type": "string"
11526233}
benefit_id4 / 7
14656{
24656 "anyOf": [
30471 {
400 "format": "uuid4",
50n/a "type": "string"
60471 },
74656 {
84656 "items": {
94654 "format": "uuid4",
10469n/a "type": "string"
114656 },
124710 "type": "array"
134656 },
140471 {
150471 "type": "null"
160471 }
174656 ],
184656}
checkout_id4 / 7
14722{
24722 "anyOf": [
30474 {
400 "format": "uuid4",
50n/a "type": "string"
60474 },
74722 {
84722 "items": {
94742 "format": "uuid4",
10476n/a "type": "string"
114722 },
124740 "type": "array"
134722 },
140474 {
150474 "type": "null"
160474 }
174722 ],
184722}
order_id4 / 7
12192{
22192 "anyOf": [
30221 {
400 "format": "uuid4",
50n/a "type": "string"
60221 },
72192 {
82192 "items": {
96441 "format": "uuid4",
10645n/a "type": "string"
112192 },
122210 "type": "array"
132192 },
140221 {
150221 "type": "null"
160221 }
172192 ],
182192}
subscription_id4 / 7
14056{
24056 "anyOf": [
30411 {
400 "format": "uuid4",
50n/a "type": "string"
60411 },
74056 {
84056 "items": {
94564 "format": "uuid4",
10460n/a "type": "string"
114056 },
124110 "type": "array"
134056 },
140411 {
150411 "type": "null"
160411 }
174056 ],
184056}
page2 / 2
128317{
22835 "exclusiveMinimum": 0,
328812 "type": "integer"
428317}
limit2 / 2
129119{
22912 "exclusiveMinimum": 0,
329317 "type": "integer"
429119}
sorting4 / 6
119212{
219212 "anyOf": [
319212 {
419212 "items": {
619212 },
72040 "type": "array"
819212 },
90204 {
100204 "type": "null"
110204 }
1219212 ],
1319212}
Referenced Components (1)3 of 3 keywords
CustomerBenefitGrantSortProperty3 of 3 keywords
183414{
283414 "enum": [
386n/a "granted_at",
4167n/a "-granted_at",
5225n/a "type",
687n/a "-type",
734n/a "organization",
882n/a "-organization",
991n/a "product_benefit",
1062n/a "-product_benefit"
1183414 ],
12837n/a "type": "string"
1383414}
Responses
codedescriptionhitsavg
200Successful Response2437ms
422Validation Error543ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2302ms
500Internal Server Error11444ms
Examples
Query
1page
10limit
[ "product_benefit", "-granted_at" ]sorting
Path Parameters
id2 / 2
#validinvalidschema
135652{
235652 "format": "uuid4",
3408n/a "type": "string"
435652}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Benefit grant not found.3175ms
422Validation Error5210ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized393ms
Path Parameters
id2 / 2
#validinvalidschema
143423{
243423 "format": "uuid4",
3457n/a "type": "string"
443423}
Body
application/json51 / 51
CustomerBenefitGrantUpdate
137054{
237054 "oneOf": [
373351 {
573351 },
626398 {
826398 },
9164260 {
11164260 },
1257367 {
1457367 },
1515409 {
1715409 },
1835389 {
2035389 }
2137054 ]
2237054}
Referenced Components (8)62 of 62 keywords
CustomerBenefitGrantCustomUpdate7 of 7 keywords
115409{
215397 "properties": {
315397 "benefit_type": {
415397 "const": "custom",
540210 "type": "string"
615397 }
715397 },
84122 "required": [
94122 "benefit_type"
104122 ],
1141410 "type": "object"
1215409}
CustomerBenefitGrantDiscordPropertiesUpdate9 of 9 keywords
110627{
210615 "properties": {
310615 "account_id": {
410615 "anyOf": [
52695 {
62695 "type": "string"
72695 },
88041 {
98041 "type": "null"
108041 }
1110615 ],
1210615 }
1310615 },
141212 "required": [
151212 "account_id"
161212 ],
1712310 "type": "object"
1810627}
CustomerBenefitGrantDiscordUpdate8 of 8 keywords
173351{
276337 "properties": {
386326 "benefit_type": {
486326 "const": "discord",
540210 "type": "string"
686326 },
710627 "properties": {
910627 }
1076337 },
11132282 "required": [
124122 "benefit_type",
13133281 "properties"
14132282 ],
1541410 "type": "object"
1673351}
CustomerBenefitGrantDownloadablesUpdate7 of 7 keywords
1164260{
2164248 "properties": {
3164248 "benefit_type": {
4164248 "const": "downloadables",
540210 "type": "string"
6164248 }
7164248 },
84122 "required": [
94122 "benefit_type"
104122 ],
1141410 "type": "object"
12164260}
CustomerBenefitGrantGitHubRepositoryPropertiesUpdate9 of 9 keywords
110627{
210615 "properties": {
310615 "account_id": {
410615 "anyOf": [
52695 {
62695 "type": "string"
72695 },
88041 {
98041 "type": "null"
108041 }
1110615 ],
1210615 }
1310615 },
141212 "required": [
151212 "account_id"
161212 ],
1712310 "type": "object"
1810627}
CustomerBenefitGrantGitHubRepositoryUpdate8 of 8 keywords
126398{
228385 "properties": {
343369 "benefit_type": {
443369 "const": "github_repository",
540210 "type": "string"
643369 },
710627 "properties": {
910627 }
1028385 },
11132282 "required": [
124122 "benefit_type",
13133281 "properties"
14132282 ],
1541410 "type": "object"
1626398}
CustomerBenefitGrantLicenseKeysUpdate7 of 7 keywords
157367{
257355 "properties": {
357355 "benefit_type": {
457355 "const": "license_keys",
540210 "type": "string"
657355 }
757355 },
84122 "required": [
94122 "benefit_type"
104122 ],
1141410 "type": "object"
1257367}
CustomerBenefitGrantMeterCreditUpdate7 of 7 keywords
135389{
235377 "properties": {
335377 "benefit_type": {
435377 "const": "meter_credit",
540210 "type": "string"
635377 }
735377 },
84122 "required": [
94122 "benefit_type"
104122 ],
1141410 "type": "object"
1235389}
Responses
codedescriptionhitsavg
200Benefit grant updated.0never seen
403The benefit grant is revoked and cannot be updated.0never seen
404Benefit grant not found.3205ms
422Validation Error923ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized352ms
400Bad Request103ms
Body
application/json4 / 4
CustomerSessionCodeAuthenticateRequest
#validinvalidschema
16842{
2685 "properties": {
3685 "code": {
4685 "type": "string"
5685 }
6685 },
77332 "required": [
87332 "code"
97332 ],
101055 "type": "object"
116842}
Responses
codedescriptionhitsavg
200Successful Response0never seen
401Invalid or expired verification code.456ms
422Validation Error532ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request22ms
500Internal Server Error23819ms
Responses
codedescriptionhitsavg
200Successful Response363ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4442ms
Body
application/json6 / 7
CustomerSessionCodeRequest
#validinvalidschema
132042{
233225 "properties": {
332620 "email": {
433214 "format": "email",
53406 "type": "string"
632620 },
73515 "organization_id": {
83510 "format": "uuid4",
93515 "type": "string"
103515 }
1133225 },
1234512 "required": [
1334611 "email",
143561 "organization_id"
1534512 ],
163575 "type": "object"
1732042}
Responses
codedescriptionhitsavg
202Successful Response1367ms
422Validation Error26114ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request352ms
Responses
codedescriptionhitsavg
200Successful Response323ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4492ms
Body
application/json31 / 31
CustomerPortalCustomerUpdate
#validinvalidschema
140995{
240184 "properties": {
341368 "billing_address": {
441368 "anyOf": [
5341140 {
7341140 },
872409 {
972409 "type": "null"
1072409 }
1141368 ]
1241368 },
134259 "billing_name": {
144259 "anyOf": [
1537397 {
1637397 "type": "string"
1737397 },
1838846 {
1938846 "type": "null"
2038846 }
214259 ],
224259 },
234208 "tax_id": {
244208 "anyOf": [
2524404 {
2624404 "type": "string"
2724404 },
2839632 {
2939632 "type": "null"
3039632 }
314208 ],
324208 }
3340184 },
3449311 "type": "object"
3540995}
Referenced Components (1)28 of 28 keywords
AddressInput28 of 28 keywords
1341140{
234355 "properties": {
33638 "city": {
43638 "anyOf": [
56365 {
66365 "type": "string"
76365 },
835714 {
935714 "type": "null"
1035714 }
113638 ],
123638 },
1338313 "country": {
1438313 "enum": [
1511n/a "AD",
169n/a "AE",
171n/a "AF",
181n/a "AG",
191n/a "AI",
201n/a "AL",
211n/a "AM",
221n/a "AO",
231n/a "AQ",
241n/a "AR",
251n/a "AS",
261n/a "AT",
272n/a "AU",
281n/a "AW",
291n/a "AX",
301n/a "AZ",
311n/a "BA",
321n/a "BB",
331n/a "BD",
341n/a "BE",
351n/a "BF",
361n/a "BG",
371n/a "BH",
381n/a "BI",
391n/a "BJ",
401n/a "BL",
411n/a "BM",
421n/a "BN",
431n/a "BO",
441n/a "BQ",
451n/a "BR",
461n/a "BS",
473n/a "BT",
481n/a "BV",
491n/a "BW",
501n/a "BY",
511n/a "BZ",
521n/a "CA",
531n/a "CC",
541n/a "CD",
551n/a "CF",
561n/a "CG",
571n/a "CH",
581n/a "CI",
591n/a "CK",
601n/a "CL",
611n/a "CM",
621n/a "CN",
631n/a "CO",
641n/a "CR",
651n/a "CV",
662n/a "CW",
671n/a "CX",
681n/a "CY",
692n/a "CZ",
701n/a "DE",
711n/a "DJ",
721n/a "DK",
731n/a "DM",
741n/a "DO",
751n/a "DZ",
761n/a "EC",
771n/a "EE",
781n/a "EG",
791n/a "EH",
802n/a "ER",
811n/a "ES",
821n/a "ET",
831n/a "FI",
841n/a "FJ",
851n/a "FK",
861n/a "FM",
871n/a "FO",
8816n/a "FR",
891n/a "GA",
901n/a "GB",
911n/a "GD",
921n/a "GE",
931n/a "GF",
941n/a "GG",
951n/a "GH",
961n/a "GI",
971n/a "GL",
981n/a "GM",
991n/a "GN",
1001n/a "GP",
1011n/a "GQ",
1021n/a "GR",
1031n/a "GS",
1041n/a "GT",
1051n/a "GU",
1061n/a "GW",
1071n/a "GY",
1081n/a "HK",
1091n/a "HM",
1101n/a "HN",
1111n/a "HR",
1121n/a "HT",
1131n/a "HU",
1141n/a "ID",
1151n/a "IE",
1161n/a "IL",
1172n/a "IM",
1181n/a "IN",
1191n/a "IO",
1201n/a "IQ",
1211n/a "IS",
1221n/a "IT",
1231n/a "JE",
1241n/a "JM",
1251n/a "JO",
1261n/a "JP",
1271n/a "KE",
1281n/a "KG",
1294n/a "KH",
1301n/a "KI",
1311n/a "KM",
1321n/a "KN",
1331n/a "KR",
1341n/a "KW",
1351n/a "KY",
1361n/a "KZ",
1371n/a "LA",
1381n/a "LB",
1392n/a "LC",
1401n/a "LI",
1411n/a "LK",
1421n/a "LR",
1431n/a "LS",
1441n/a "LT",
1451n/a "LU",
1461n/a "LV",
1471n/a "LY",
1481n/a "MA",
1491n/a "MC",
1501n/a "MD",
1511n/a "ME",
1521n/a "MF",
1531n/a "MG",
1542n/a "MH",
1551n/a "MK",
1561n/a "ML",
1571n/a "MM",
1581n/a "MN",
1591n/a "MO",
1601n/a "MP",
1611n/a "MQ",
1621n/a "MR",
1631n/a "MS",
1641n/a "MT",
1651n/a "MU",
1663n/a "MV",
1672n/a "MW",
1681n/a "MX",
1691n/a "MY",
1701n/a "MZ",
1711n/a "NA",
1721n/a "NC",
1732n/a "NE",
1741n/a "NF",
1751n/a "NG",
1761n/a "NI",
1771n/a "NL",
1781n/a "NO",
1792n/a "NP",
1801n/a "NR",
1811n/a "NU",
1821n/a "NZ",
1831n/a "OM",
1841n/a "PA",
1851n/a "PE",
1861n/a "PF",
1871n/a "PG",
1882n/a "PH",
1891n/a "PK",
1901n/a "PL",
1912n/a "PM",
1922n/a "PN",
1931n/a "PR",
1941n/a "PS",
1951n/a "PT",
1961n/a "PW",
1971n/a "PY",
1981n/a "QA",
1991n/a "RE",
2001n/a "RO",
2011n/a "RS",
2021n/a "RW",
2031n/a "SA",
2041n/a "SB",
2051n/a "SC",
2061n/a "SD",
2072n/a "SE",
2081n/a "SG",
2091n/a "SH",
2101n/a "SI",
2111n/a "SJ",
2121n/a "SK",
2131n/a "SL",
2141n/a "SM",
2151n/a "SN",
2161n/a "SO",
2171n/a "SR",
2181n/a "SS",
2192n/a "ST",
2202n/a "SV",
2212n/a "SX",
2222n/a "SZ",
2232n/a "TC",
2242n/a "TD",
2252n/a "TF",
2262n/a "TG",
2272n/a "TH",
2282n/a "TJ",
2292n/a "TK",
2304n/a "TL",
2312n/a "TM",
2322n/a "TN",
2332n/a "TO",
2342n/a "TR",
2352n/a "TT",
2362n/a "TV",
2372n/a "TW",
2383n/a "TZ",
2392n/a "UA",
2402n/a "UG",
2412n/a "UM",
24242n/a "US",
2432n/a "UY",
2442n/a "UZ",
2452n/a "VA",
2462n/a "VC",
2472n/a "VE",
2484n/a "VG",
2492n/a "VI",
2502n/a "VN",
2512n/a "VU",
2522n/a "WF",
2532n/a "WS",
2542n/a "YE",
2552n/a "YT",
2562n/a "ZA",
2572n/a "ZM",
2582n/a "ZW"
25938313 ],
26038610 "type": "string",
26138313 },
2623578 "line1": {
2633578 "anyOf": [
2644361 {
2654361 "type": "string"
2664361 },
26735312 {
26835312 "type": "null"
26935312 }
2703578 ],
2713578 },
27235310 "line2": {
27335310 "anyOf": [
2743360 {
2753360 "type": "string"
2763360 },
27735013 {
27835013 "type": "null"
27935013 }
28035310 ],
28135310 },
2823499 "postal_code": {
2833499 "anyOf": [
2844354 {
2854354 "type": "string"
2864354 },
28734513 {
28834513 "type": "null"
28934513 }
2903499 ],
2913499 },
2923509 "state": {
2933509 "anyOf": [
2944355 {
2954355 "type": "string"
2964355 },
29734613 {
29834613 "type": "null"
29934613 }
3003509 ],
3013509 }
30234355 },
3033964 "required": [
3043964 "country"
3053964 ],
30640081 "type": "object"
307341140}
Responses
codedescriptionhitsavg
200Customer updated.0never seen
422Validation Error1543ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error3501005ms
401Unauthorized332ms
400Bad Request353ms
Examples
Body: application/json
"US"AddressInput.country.examples[0]
"SE"AddressInput.country.examples[1]
"FR"AddressInput.country.examples[2]
Query Parameters
page2 / 2
#validinvalidschema
1156139{
215629 "exclusiveMinimum": 0,
3185110 "type": "integer"
4156139}
limit2 / 2
1161203{
216125 "exclusiveMinimum": 0,
3186178 "type": "integer"
4161203}
Responses
codedescriptionhitsavg
200Successful Response1474ms
422Validation Error2645ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized742ms
Examples
Query
1page
10limit
Body
application/json6 / 6
CustomerPaymentMethodCreate
#validinvalidschema
14439{
24731 "properties": {
35621 "confirmation_token_id": {
45621 "type": "string"
55621 },
66017 "return_url": {
76017 "type": "string"
86017 },
9725 "set_default": {
10725 "type": "boolean"
11725 }
124731 },
13753 "required": [
14771 "confirmation_token_id",
15771 "set_default",
16771 "return_url"
17753 ],
18785 "type": "object"
194439}
Responses
codedescriptionhitsavg
201Payment method created or setup initiated.0never seen
422Validation Error544ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized243ms
500Internal Server Error211086ms
Body
application/json5 / 5
CustomerPaymentMethodConfirm
#validinvalidschema
16143{
27421 "properties": {
37416 "set_default": {
47416 "type": "boolean"
57416 },
6789 "setup_intent_id": {
7789 "type": "string"
8789 }
97421 },
108216 "required": [
118711 "setup_intent_id",
12908 "set_default"
138216 ],
14986 "type": "object"
156143}
Responses
codedescriptionhitsavg
201Payment method created or setup initiated.0never seen
400Customer is not ready to confirm a payment method.523ms
422Validation Error1046ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2711ms
500Internal Server Error121222ms
Path Parameters
id2 / 2
#validinvalidschema
138569{
238569 "format": "uuid4",
3454n/a "type": "string"
438569}
Responses
codedescriptionhitsavg
204Payment method deleted.0never seen
400Payment method is used by active subscription(s).0never seen
404Payment method not found.3274ms
422Validation Error693ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized582ms
Query Parameters
benefit_id2 / 7
#validinvalidschema
15830{
25830 "anyOf": [
30583 {
400 "format": "uuid4",
50n/a "type": "string",
60583 },
75830 {
85830 "items": {
96200 "format": "uuid4",
10620n/a "type": "string",
115830 },
125830 "type": "array"
135830 },
140583 {
150583 "type": "null"
160583 }
175830 ],
185830}
page2 / 2
123016{
22303 "exclusiveMinimum": 0,
323313 "type": "integer"
423016}
limit2 / 2
120816{
22082 "exclusiveMinimum": 0,
321014 "type": "integer"
420816}
Responses
codedescriptionhitsavg
200Successful Response3985ms
422Validation Error253ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2512ms
500Internal Server Error41402ms
Examples
Query
1page
10limit
Path Parameters
token1 / 1
#validinvalidschema
1466n/a{
2466n/a "type": "string"
3466n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
302Redirected to download0never seen
400Invalid signature0never seen
404Downloadable not found4663ms
410Expired signature0never seen
422Validation Error0never seen
Query Parameters
benefit_id3 / 4
#validinvalidschema
14971{
24971 "anyOf": [
34971 {
44971 "format": "uuid4",
5498n/a "type": "string",
64971 },
70498 {
80498 "type": "null"
90498 }
104971 ],
114971}
page2 / 2
116720{
21673 "exclusiveMinimum": 0,
317017 "type": "integer"
416720}
limit2 / 2
124417{
22443 "exclusiveMinimum": 0,
324714 "type": "integer"
424417}
Responses
codedescriptionhitsavg
200Successful Response3155ms
401Not authorized to manage license key.2382ms
404License key not found.0never seen
422Validation Error253ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error71301ms
Examples
Query
1page
10limit
Body
application/json25 / 29
LicenseKeyActivate
#validinvalidschema
133845{
234533 "properties": {
317010 "conditions": {
4843 "additionalProperties": {
53313 "anyOf": [
6112222 {
71150 "maxLength": 500,
81123 "minLength": 1,
9115219 "type": "string"
10112222 },
1177257 {
1277257 "type": "integer"
1377257 },
14110224 {
15110224 "type": "number"
16110224 },
17109225 {
18109225 "type": "boolean"
19109225 }
203313 ]
21843 },
221731 "maxProperties": 50,
23843 "propertyNames": {
243331 "maxLength": 40,
253322 "minLength": 1
26843 },
271746 "type": "object"
2817010 },
293685 "key": {
303685 "type": "string"
313685 },
323716 "label": {
333716 "type": "string"
343716 },
351499 "meta": {
36824 "additionalProperties": {
3724310 "anyOf": [
3884169 {
39880 "maxLength": 500,
40844 "minLength": 1,
4188165 "type": "string"
4284169 },
4345208 {
4445208 "type": "integer"
4545208 },
4672181 {
4772181 "type": "number"
4872181 },
4987166 {
5087166 "type": "boolean"
5187166 }
5224310 ]
53824 },
541530 "maxProperties": 50,
55842 "propertyNames": {
562521 "maxLength": 40,
572521 "minLength": 1
58842 },
591535 "type": "object"
601499 },
613725 "organization_id": {
623720 "format": "uuid4",
633725 "type": "string"
643725 }
6534533 },
663717 "required": [
673735 "key",
683771 "organization_id",
693771 "label"
703717 ],
713785 "type": "object"
7233845}
Responses
codedescriptionhitsavg
200Successful Response0never seen
403License key activation not supported or limit reached. Use /validate endpoint for licenses without activations.0never seen
404License key not found.3345ms
422Validation Error2512ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1372ms
500Internal Server Error41259ms
Body
application/json6 / 8
LicenseKeyDeactivate
#validinvalidschema
118838{
219922 "properties": {
321010 "activation_id": {
42100 "format": "uuid4",
521010 "type": "string"
621010 },
72057 "key": {
82057 "type": "string"
92057 },
102155 "organization_id": {
112150 "format": "uuid4",
122155 "type": "string"
132155 }
1419922 },
1521011 "required": [
162129 "key",
172201 "organization_id",
182201 "activation_id"
1921011 ],
202215 "type": "object"
2118838}
Responses
codedescriptionhitsavg
204License key activation deactivated.0never seen
404License key not found.1884ms
422Validation Error1232ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1255ms
Body
application/json26 / 32
LicenseKeyValidate
#validinvalidschema
115872{
218936 "properties": {
31074 "activation_id": {
41074 "anyOf": [
57833 {
6780 "format": "uuid4",
77833 "type": "string"
87833 },
92982 {
102982 "type": "null"
112982 }
121074 ],
131074 },
141804 "benefit_id": {
151804 "anyOf": [
1617014 {
171700 "format": "uuid4",
1817014 "type": "string",
1917014 },
2010174 {
2110174 "type": "null"
2210174 }
231804 ],
241804 },
251197 "conditions": {
26542 "additionalProperties": {
271662 "anyOf": [
2840128 {
29420 "maxLength": 500,
30402 "minLength": 1,
3142126 "type": "string"
3240128 },
3347121 {
3447121 "type": "integer"
3547121 },
3656112 {
3756112 "type": "number"
3856112 },
397098 {
407098 "type": "boolean"
417098 }
421662 ]
43542 },
441210 "maxProperties": 50,
45542 "propertyNames": {
461671 "maxLength": 40,
471671 "minLength": 1
48542 },
491215 "type": "object"
501197 },
511105 "customer_id": {
521105 "anyOf": [
538332 {
54830 "format": "uuid4",
558332 "type": "string"
568332 },
572788 {
582788 "type": "null"
592788 }
601105 ],
611105 },
62986 "increment_usage": {
63986 "anyOf": [
642975 {
652975 "type": "integer"
662975 },
676935 {
686935 "type": "null"
696935 }
70986 ],
71986 },
721896 "key": {
731896 "type": "string"
741896 },
752185 "organization_id": {
762180 "format": "uuid4",
772185 "type": "string"
782185 }
7918936 },
8019431 "required": [
8119530 "key",
822232 "organization_id"
8319431 ],
842255 "type": "object"
8515872}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404License key not found.1584ms
422Validation Error1492ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request902ms
500Internal Server Error11412ms
Path Parameters
id2 / 2
#validinvalidschema
134167{
234167 "format": "uuid4",
3408n/a "type": "string"
434167}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404License key not found.2895ms
422Validation Error679ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized522ms
Query Parameters
meter_id4 / 7
#validinvalidschema
1144147{
2144147 "anyOf": [
30291 {
400 "format": "uuid4",
50n/a "type": "string"
60291 },
7144147 {
8144147 "items": {
9470846 "format": "uuid4",
101316n/a "type": "string"
11144147 },
122910 "type": "array"
13144147 },
140291 {
150291 "type": "null"
160291 }
17144147 ],
18144147}
query3 / 3
1163n/a{
2163n/a "anyOf": [
3134n/a {
4134n/a "type": "string"
5134n/a },
629134 {
729134 "type": "null"
829134 }
9163n/a ],
10163n/a}
page2 / 2
116536{
216514 "exclusiveMinimum": 0,
317922 "type": "integer"
416536}
limit2 / 2
121220{
22123 "exclusiveMinimum": 0,
321517 "type": "integer"
421220}
sorting4 / 6
114973{
214973 "anyOf": [
314973 {
414973 "items": {
614973 },
72220 "type": "array"
814973 },
90222 {
100222 "type": "null"
110222 }
1214973 ],
1314973}
Referenced Components (1)3 of 3 keywords
CustomerCustomerMeterSortProperty3 of 3 keywords
1667119{
2667119 "enum": [
339n/a "created_at",
425n/a "-created_at",
531n/a "modified_at",
660n/a "-modified_at",
733n/a "meter_id",
847n/a "-meter_id",
941n/a "meter_name",
1059n/a "-meter_name",
1149n/a "consumed_units",
1234n/a "-consumed_units",
1334n/a "credited_units",
1463n/a "-credited_units",
15103n/a "balance",
1649n/a "-balance"
17667119 ],
18722n/a "type": "string"
19667119}
Responses
codedescriptionhitsavg
200Successful Response2506ms
422Validation Error1944ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1863ms
500Internal Server Error71597ms
Examples
Query
1page
10limit
[ "-modified_at" ]sorting
Path Parameters
id2 / 2
#validinvalidschema
137042{
237042 "format": "uuid4",
3412n/a "type": "string"
437042}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Customer meter not found.2895ms
422Validation Error424ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized812ms
Query Parameters
platform2 / 2
CustomerOAuthPlatform
#validinvalidschema
142623{
242623 "enum": [
3342n/a "github",
484n/a "discord"
542623 ],
6449n/a "type": "string"
742623}
customer_id2 / 2
140544{
240544 "format": "uuid",
3449n/a "type": "string"
440544}
return_to3 / 3
191n/a{
291n/a "anyOf": [
377n/a {
477n/a "type": "string"
577n/a },
61477 {
71477 "type": "null"
81477 }
991n/a ],
1091n/a}
Responses
codedescriptionhitsavg
200Successful Response3114ms
422Validation Error753ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized712ms
Query Parameters
state1 / 1
#validinvalidschema
133n/a{
233n/a "type": "string"
333n/a}
code2 / 3
112n/a{
212n/a "anyOf": [
312n/a {
412n/a "type": "string"
512n/a },
6012 {
7012 "type": "null"
8012 }
912n/a ],
1012n/a}
error2 / 3
18n/a{
28n/a "anyOf": [
38n/a {
48n/a "type": "string"
58n/a },
608 {
708 "type": "null"
808 }
98n/a ],
108n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error14ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error33781ms
Query Parameters
product_id4 / 7
#validinvalidschema
16018{
26018 "anyOf": [
30609 {
400 "format": "uuid4",
50n/a "type": "string",
60609 },
76018 {
86018 "items": {
965416 "format": "uuid4",
10670n/a "type": "string",
116018 },
126090 "type": "array"
136018 },
140609 {
150609 "type": "null"
160609 }
176018 ],
186018}
product_billing_type4 / 7
120543{
220543 "anyOf": [
30248 {
50248 },
620543 {
720543 "items": {
920543 },
102480 "type": "array"
1120543 },
120248 {
130248 "type": "null"
140248 }
1520543 ],
1620543}
Referenced Components (1)3 of 3 keywords
ProductBillingType3 of 3 keywords
1604437{
2604437 "enum": [
3369n/a "one_time",
4235n/a "recurring"
5604437 ],
6778n/a "type": "string"
7604437}
subscription_id4 / 7
139613{
239613 "anyOf": [
30409 {
400 "format": "uuid4",
50n/a "type": "string"
60409 },
739613 {
839613 "items": {
946210 "format": "uuid4",
10472n/a "type": "string"
1139613 },
124090 "type": "array"
1339613 },
140409 {
150409 "type": "null"
160409 }
1739613 ],
1839613}
query3 / 3
1195n/a{
2195n/a "anyOf": [
3178n/a {
4178n/a "type": "string"
5178n/a },
617178 {
717178 "type": "null"
817178 }
9195n/a ],
10195n/a}
page2 / 2
134817{
23483 "exclusiveMinimum": 0,
335114 "type": "integer"
434817}
limit2 / 2
135517{
23553 "exclusiveMinimum": 0,
335814 "type": "integer"
435517}
sorting4 / 6
119125{
219125 "anyOf": [
319125 {
419125 "items": {
619125 },
72160 "type": "array"
819125 },
90216 {
100216 "type": "null"
110216 }
1219125 ],
1319125}
Referenced Components (1)3 of 3 keywords
CustomerOrderSortProperty3 of 3 keywords
198655{
298655 "enum": [
371n/a "created_at",
458n/a "-created_at",
5413n/a "amount",
675n/a "-amount",
766n/a "net_amount",
842n/a "-net_amount",
974n/a "product",
1093n/a "-product",
1175n/a "subscription",
1219n/a "-subscription"
1398655 ],
141019n/a "type": "string"
1598655}
Responses
codedescriptionhitsavg
200Successful Response32914ms
422Validation Error794ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2672ms
500Internal Server Error61504ms
Examples
Query
1page
10limit
[ "-created_at" ]sorting
Path Parameters
id2 / 2
#validinvalidschema
135848{
235848 "format": "uuid4",
3406n/a "type": "string"
435848}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Order not found.3035ms
422Validation Error484ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized552ms
Path Parameters
id2 / 2
#validinvalidschema
169224{
269224 "format": "uuid4",
3716n/a "type": "string"
469224}
Body
application/json29 / 29
CustomerOrderUpdate
142167{
242855 "properties": {
343151 "billing_address": {
443151 "anyOf": [
5329153 {
7329153 },
8102380 {
9102380 "type": "null"
10102380 }
1143151 ],
1243151 },
134716 "billing_name": {
144716 "anyOf": [
15159318 {
16159318 "type": "string"
17159318 },
18312165 {
19312165 "type": "null"
20312165 }
214716 ],
224716 }
2342855 },
244767 "required": [
254776 "billing_name",
264821 "billing_address"
274767 ],
284835 "type": "object"
2942167}
Referenced Components (1)28 of 28 keywords
AddressInput28 of 28 keywords
1329153{
233044 "properties": {
331513 "city": {
431513 "anyOf": [
517311 {
617311 "type": "string"
717311 },
829830 {
929830 "type": "null"
1029830 }
1131513 ],
1231513 },
133667 "country": {
143667 "enum": [
1534n/a "AD",
162n/a "AE",
171n/a "AF",
181n/a "AG",
191n/a "AI",
201n/a "AL",
213n/a "AM",
221n/a "AO",
231n/a "AQ",
241n/a "AR",
251n/a "AS",
261n/a "AT",
271n/a "AU",
281n/a "AW",
291n/a "AX",
301n/a "AZ",
311n/a "BA",
321n/a "BB",
331n/a "BD",
344n/a "BE",
351n/a "BF",
361n/a "BG",
372n/a "BH",
381n/a "BI",
391n/a "BJ",
401n/a "BL",
411n/a "BM",
421n/a "BN",
431n/a "BO",
443n/a "BQ",
451n/a "BR",
461n/a "BS",
471n/a "BT",
481n/a "BV",
492n/a "BW",
501n/a "BY",
511n/a "BZ",
521n/a "CA",
531n/a "CC",
542n/a "CD",
551n/a "CF",
562n/a "CG",
573n/a "CH",
581n/a "CI",
591n/a "CK",
604n/a "CL",
611n/a "CM",
621n/a "CN",
631n/a "CO",
641n/a "CR",
651n/a "CV",
661n/a "CW",
671n/a "CX",
681n/a "CY",
691n/a "CZ",
701n/a "DE",
711n/a "DJ",
721n/a "DK",
731n/a "DM",
741n/a "DO",
751n/a "DZ",
761n/a "EC",
771n/a "EE",
781n/a "EG",
791n/a "EH",
801n/a "ER",
811n/a "ES",
821n/a "ET",
833n/a "FI",
841n/a "FJ",
851n/a "FK",
861n/a "FM",
871n/a "FO",
882n/a "FR",
891n/a "GA",
903n/a "GB",
912n/a "GD",
921n/a "GE",
931n/a "GF",
941n/a "GG",
951n/a "GH",
961n/a "GI",
971n/a "GL",
981n/a "GM",
991n/a "GN",
1001n/a "GP",
1012n/a "GQ",
1027n/a "GR",
1031n/a "GS",
1041n/a "GT",
1051n/a "GU",
1061n/a "GW",
1071n/a "GY",
1081n/a "HK",
1091n/a "HM",
1108n/a "HN",
1111n/a "HR",
1121n/a "HT",
1131n/a "HU",
1141n/a "ID",
1151n/a "IE",
1161n/a "IL",
1171n/a "IM",
1181n/a "IN",
1191n/a "IO",
1201n/a "IQ",
1211n/a "IS",
1221n/a "IT",
1231n/a "JE",
1241n/a "JM",
1251n/a "JO",
1261n/a "JP",
1271n/a "KE",
1281n/a "KG",
1291n/a "KH",
1302n/a "KI",
1311n/a "KM",
1321n/a "KN",
1331n/a "KR",
1341n/a "KW",
1353n/a "KY",
1361n/a "KZ",
1371n/a "LA",
1381n/a "LB",
1391n/a "LC",
1401n/a "LI",
1411n/a "LK",
1425n/a "LR",
1431n/a "LS",
1441n/a "LT",
1451n/a "LU",
1461n/a "LV",
1471n/a "LY",
1481n/a "MA",
1491n/a "MC",
1501n/a "MD",
1511n/a "ME",
1521n/a "MF",
1532n/a "MG",
1541n/a "MH",
1551n/a "MK",
1562n/a "ML",
1571n/a "MM",
1581n/a "MN",
1591n/a "MO",
1601n/a "MP",
1611n/a "MQ",
1621n/a "MR",
1631n/a "MS",
1641n/a "MT",
1651n/a "MU",
1661n/a "MV",
1671n/a "MW",
1681n/a "MX",
1691n/a "MY",
1701n/a "MZ",
1713n/a "NA",
1721n/a "NC",
1731n/a "NE",
1741n/a "NF",
1751n/a "NG",
1761n/a "NI",
1771n/a "NL",
1781n/a "NO",
1791n/a "NP",
1801n/a "NR",
1811n/a "NU",
1821n/a "NZ",
1831n/a "OM",
1841n/a "PA",
1851n/a "PE",
1861n/a "PF",
1871n/a "PG",
1881n/a "PH",
1891n/a "PK",
1901n/a "PL",
1911n/a "PM",
1921n/a "PN",
1931n/a "PR",
1941n/a "PS",
1951n/a "PT",
1961n/a "PW",
1971n/a "PY",
1981n/a "QA",
1991n/a "RE",
2001n/a "RO",
2011n/a "RS",
2021n/a "RW",
2031n/a "SA",
2041n/a "SB",
2051n/a "SC",
2061n/a "SD",
2072n/a "SE",
2081n/a "SG",
2091n/a "SH",
2101n/a "SI",
2111n/a "SJ",
2121n/a "SK",
2131n/a "SL",
2141n/a "SM",
2151n/a "SN",
2161n/a "SO",
2171n/a "SR",
2181n/a "SS",
2191n/a "ST",
2202n/a "SV",
2211n/a "SX",
2221n/a "SZ",
2232n/a "TC",
2241n/a "TD",
2251n/a "TF",
2262n/a "TG",
2271n/a "TH",
2281n/a "TJ",
2292n/a "TK",
2301n/a "TL",
2311n/a "TM",
2321n/a "TN",
2331n/a "TO",
2341n/a "TR",
2352n/a "TT",
2361n/a "TV",
2371n/a "TW",
2381n/a "TZ",
2391n/a "UA",
2401n/a "UG",
2411n/a "UM",
24236n/a "US",
2431n/a "UY",
2441n/a "UZ",
2451n/a "VA",
2461n/a "VC",
2471n/a "VE",
2481n/a "VG",
2491n/a "VI",
2501n/a "VN",
2511n/a "VU",
2521n/a "WF",
2531n/a "WS",
2541n/a "YE",
2551n/a "YT",
2561n/a "ZA",
2571n/a "ZM",
2581n/a "ZW"
2593667 ],
2603685 "type": "string",
2613667 },
2623045 "line1": {
2633045 "anyOf": [
26411298 {
26511298 "type": "string"
26611298 },
26729316 {
26829316 "type": "null"
26929316 }
2703045 ],
2713045 },
27229717 "line2": {
27329717 "anyOf": [
2747307 {
2757307 "type": "string"
2767307 },
27729024 {
27829024 "type": "null"
27929024 }
28029717 ],
28129717 },
2823004 "postal_code": {
2833004 "anyOf": [
28419285 {
28519285 "type": "string"
28619285 },
28728123 {
28828123 "type": "null"
28928123 }
2903004 ],
2913004 },
2923056 "state": {
2933056 "anyOf": [
29419292 {
29519292 "type": "string"
29619292 },
29728625 {
29828625 "type": "null"
29928625 }
3003056 ],
3013056 }
30233044 },
3033732 "required": [
3043732 "country"
3053732 ],
306375107 "type": "object"
307329153}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Order not found.3785ms
422Validation Error1503ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized312ms
500Internal Server Error5826ms
400Bad Request1523ms
Examples
Body: application/json
"US"AddressInput.country.examples[0]
"SE"AddressInput.country.examples[1]
"FR"AddressInput.country.examples[2]
Path Parameters
id2 / 2
#validinvalidschema
140043{
240043 "format": "uuid4",
3443n/a "type": "string"
440043}
Body
application/json12 / 12
CustomerOrderConfirmPayment
135358{
26551 "properties": {
36822 "confirmation_token_id": {
46822 "anyOf": [
51377 {
61377 "type": "string"
71377 },
85535 {
95535 "type": "null"
105535 }
116822 ],
126822 },
136128 "payment_method_id": {
146128 "anyOf": [
153752 {
16377 "format": "uuid4",
174445 "type": "string"
183752 },
192465 {
202465 "type": "null"
212465 }
226128 ],
236128 },
244334 "payment_processor": {
264334 }
276551 },
284047 "type": "object"
2935358}
Referenced Components (1)3 of 3 keywords
PaymentProcessor3 of 3 keywords
14334{
24334 "enum": [
343n/a "stripe"
44334 ],
55918 "type": "string"
64334}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Order not found.188ms
409Payment already in progress.0never seen
422Order not eligible for retry or payment confirmation failed.4044ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized152ms
400Bad Request63ms
Examples
Body: application/json
"stripe"CustomerOrderConfirmPayment.payment_processor
Path Parameters
id2 / 2
#validinvalidschema
136250{
236250 "format": "uuid4",
3412n/a "type": "string"
436250}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Order not found.2915ms
422Validation Error503ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized712ms
Path Parameters
id2 / 2
#validinvalidschema
136255{
236255 "format": "uuid4",
3417n/a "type": "string"
436255}
Responses
codedescriptionhitsavg
202Successful Response0never seen
422Order is not paid or is missing billing name or address.554ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized692ms
404Not Found2936ms
Path Parameters
id2 / 2
#validinvalidschema
135953{
235953 "format": "uuid4",
3412n/a "type": "string"
435953}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Order not found.3225ms
422Validation Error534ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized372ms
Path Parameters
slug1 / 1
#validinvalidschema
17n/a{
27n/a "type": "string"
37n/a}
Responses
codedescriptionhitsavg
200Successful Response79ms
404Organization not found.0never seen
422Validation Error0never seen
Query Parameters
subscription_id3 / 4
#validinvalidschema
130878{
230878 "anyOf": [
330878 {
430878 "format": "uuid4",
5386n/a "type": "string"
630878 },
70386 {
80386 "type": "null"
90386 }
1030878 ],
1130878}
order_id4 / 4
1113122{
2113122 "anyOf": [
3112123 {
4112122 "format": "uuid4",
5234n/a "type": "string"
6112123 },
71234 {
81234 "type": "null"
91234 }
10113122 ],
11113122}
Responses
codedescriptionhitsavg
200Successful Response0never seen
401Authentication required1502ms
403Not permitted or seat-based pricing not enabled0never seen
404Subscription or order not found2286ms
422Validation Error1264ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request894ms
Body
application/json30 / 30
SeatAssign
#validinvalidschema
132250{
231944 "properties": {
33456 "checkout_id": {
43456 "anyOf": [
534110 {
63412 "format": "uuid",
73438 "type": "string"
834110 },
94347 {
104347 "type": "null"
114347 }
123456 ],
133456 },
141916 "customer_id": {
151916 "anyOf": [
1612671 {
171262 "format": "uuid",
1812869 "type": "string"
1912671 },
2065132 {
2165132 "type": "null"
2265132 }
231916 ],
241916 },
251937 "email": {
261937 "anyOf": [
2717129 {
281982 "format": "email",
2917327 "type": "string"
3017129 },
3122178 {
3222178 "type": "null"
3322178 }
341937 ],
351937 },
362065 "external_customer_id": {
372065 "anyOf": [
38111100 {
39111100 "type": "string"
40111100 },
4195116 {
4295116 "type": "null"
4395116 }
442065 ],
452065 },
462045 "immediate_claim": {
472045 "type": "boolean"
482045 },
491934 "metadata": {
501934 "anyOf": [
5165132 {
521n/a "additionalProperties": true,
5365132 "type": "object"
5465132 },
5512869 {
5612869 "type": "null"
5712869 }
581934 ],
591934 },
601896 "order_id": {
611896 "anyOf": [
6214748 {
631472 "format": "uuid",
6414946 "type": "string"
6514748 },
6642153 {
6742153 "type": "null"
6842153 }
691896 ],
701896 },
712986 "subscription_id": {
722986 "anyOf": [
7329014 {
742902 "format": "uuid",
7529212 "type": "string"
7629014 },
778296 {
788296 "type": "null"
798296 }
802986 ],
812986 }
8231944 },
833666 "type": "object"
8432250}
Responses
codedescriptionhitsavg
200Successful Response0never seen
400No available seats or customer already has a seat733ms
401Authentication required892ms
403Not permitted or seat-based pricing not enabled0never seen
404Subscription, order, or customer not found0never seen
422Validation Error3264ms
Examples
Body: application/json
falseSeatAssign.immediate_claim
Responses
codedescriptionhitsavg
200Successful Response1626ms
401Authentication required5312ms
Path Parameters
seat_id2 / 2
#validinvalidschema
134064{
234064 "format": "uuid4",
3404n/a "type": "string"
434064}
Responses
codedescriptionhitsavg
200Successful Response0never seen
401Authentication required672ms
403Not permitted or seat-based pricing not enabled0never seen
404Seat not found2736ms
422Validation Error643ms
Path Parameters
seat_id2 / 2
#validinvalidschema
150071{
250071 "format": "uuid4",
3571n/a "type": "string"
450071}
Responses
codedescriptionhitsavg
200Successful Response0never seen
400Seat is not pending or already claimed0never seen
401Authentication required762ms
403Not permitted or seat-based pricing not enabled0never seen
404Seat not found4246ms
422Validation Error714ms
Query Parameters
product_id2 / 7
#validinvalidschema
15500{
25500 "anyOf": [
30550 {
400 "format": "uuid4",
50n/a "type": "string",
60550 },
75500 {
85500 "items": {
96240 "format": "uuid4",
10624n/a "type": "string",
115500 },
125500 "type": "array"
135500 },
140550 {
150550 "type": "null"
160550 }
175500 ],
185500}
active3 / 3
111915{
211915 "anyOf": [
311816 {
411816 "type": "boolean"
511816 },
61133 {
71133 "type": "null"
81133 }
911915 ],
1011915}
query3 / 3
1239n/a{
2239n/a "anyOf": [
3234n/a {
4234n/a "type": "string"
5234n/a },
65234 {
75234 "type": "null"
85234 }
9239n/a ],
10239n/a}
page2 / 2
126120{
22614 "exclusiveMinimum": 0,
326516 "type": "integer"
426120}
limit2 / 2
128217{
22824 "exclusiveMinimum": 0,
328613 "type": "integer"
428217}
sorting4 / 6
111414{
211414 "anyOf": [
311414 {
411414 "items": {
611414 },
71280 "type": "array"
811414 },
90128 {
100128 "type": "null"
110128 }
1211414 ],
1311414}
Referenced Components (1)3 of 3 keywords
CustomerSubscriptionSortProperty3 of 3 keywords
159743{
259743 "enum": [
351n/a "started_at",
493n/a "-started_at",
561n/a "amount",
665n/a "-amount",
757n/a "status",
856n/a "-status",
979n/a "organization",
1046n/a "-organization",
1139n/a "product",
1250n/a "-product"
1359743 ],
14623n/a "type": "string"
1559743}
Responses
codedescriptionhitsavg
200Successful Response4026ms
422Validation Error543ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2463ms
500Internal Server Error41424ms
Examples
Query
1page
10limit
[ "-started_at" ]sorting
Path Parameters
id2 / 2
#validinvalidschema
136052{
236052 "format": "uuid4",
3412n/a "type": "string"
436052}
Responses
codedescriptionhitsavg
200Customer subscription is canceled.0never seen
403Customer subscription is already canceled or will be at the end of the period.0never seen
404Customer subscription was not found.3005ms
422Validation Error524ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized602ms
Path Parameters
id2 / 2
#validinvalidschema
136146{
236146 "format": "uuid4",
3407n/a "type": "string"
436146}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Customer subscription was not found.3065ms
422Validation Error463ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized552ms
Path Parameters
id2 / 2
#validinvalidschema
142729{
242729 "format": "uuid4",
3456n/a "type": "string"
442729}
Body
application/json25 / 32
CustomerSubscriptionUpdate
138034{
238034 "anyOf": [
3280134 {
5280134 },
651363 {
851363 },
938034 {
1138034 }
1238034 ]
1338034}
Referenced Components (5)29 of 39 keywords
CustomerCancellationReason3 of 3 keywords
11832{
21832 "enum": [
35n/a "customer_service",
41n/a "low_quality",
51n/a "missing_features",
61n/a "switched_service",
75n/a "too_complex",
81n/a "too_expensive",
92n/a "unused",
102n/a "other"
111832 ],
122030 "type": "string"
131832}
CustomerSubscriptionCancel15 of 15 keywords
138034{
23723 "properties": {
3415 "cancel_at_period_end": {
4415 "anyOf": [
5937 {
6937 "type": "boolean"
7937 },
83214 {
93214 "type": "null"
103214 }
11415 ],
12415 },
134113 "cancellation_comment": {
144113 "anyOf": [
151341 {
161341 "type": "string"
171341 },
182826 {
192826 "type": "null"
202826 }
214113 ],
224113 },
23428 "cancellation_reason": {
24428 "anyOf": [
251832 {
271832 },
282426 {
292426 "type": "null"
302426 }
31428 ],
32428 }
333723 },
3440311 "type": "object"
3538034}
CustomerSubscriptionUpdateProduct3 of 7 keywords
1280134{
22800 "properties": {
32800 "product_id": {
42800 "format": "uuid4",
52800 "type": "string"
62800 }
72800 },
8280123 "required": [
9280123 "product_id"
10280123 ],
1140311 "type": "object"
12280134}
CustomerSubscriptionUpdateSeats5 of 11 keywords
151363{
2510 "properties": {
3190 "proration_behavior": {
4190 "anyOf": [
5910 {
7910 },
8109 {
9109 "type": "null"
10109 }
11190 ],
12190 },
13510 "seats": {
14510 "minimum": 1.0,
15510 "type": "integer"
16510 }
17510 },
1851352 "required": [
1951352 "seats"
2051352 ],
2140311 "type": "object"
2251363}
SubscriptionProrationBehavior3 of 3 keywords
1910{
2910 "enum": [
35n/a "invoice",
44n/a "prorate"
5910 ],
6910 "type": "string"
7910}
Responses
codedescriptionhitsavg
200Customer subscription updated.0never seen
403Customer subscription is already canceled or will be at the end of the period.0never seen
404Customer subscription was not found.3395ms
422Validation Error853ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized222ms
400Bad Request103ms
Path Parameters
id2 / 2
#validinvalidschema
139515{
239515 "format": "uuid4",
3410n/a "type": "string"
439515}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Customer subscription was not found.3125ms
422Validation Error153ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized832ms
Query Parameters
page2 / 2
#validinvalidschema
1204141{
220448 "exclusiveMinimum": 0,
325293 "type": "integer"
4204141}
limit2 / 2
124591{
224565 "exclusiveMinimum": 0,
331026 "type": "integer"
424591}
sorting4 / 6
1131151{
2131151 "anyOf": [
3131151 {
4131151 "items": {
6131151 },
72820 "type": "array"
8131151 },
90282 {
100282 "type": "null"
110282 }
12131151 ],
13131151}
Referenced Components (1)3 of 3 keywords
CustomerWalletSortProperty3 of 3 keywords
11174229{
21174229 "enum": [
3166n/a "created_at",
4199n/a "-created_at",
5575n/a "balance",
6234n/a "-balance"
71174229 ],
81281n/a "type": "string"
91174229}
Responses
codedescriptionhitsavg
200Successful Response2595ms
422Validation Error1994ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2002ms
500Internal Server Error41698ms
Examples
Query
1page
10limit
[ "-created_at" ]sorting
Path Parameters
id2 / 2
#validinvalidschema
136274{
236274 "format": "uuid4",
3436n/a "type": "string"
436274}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Wallet not found.2984ms
422Validation Error743ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized642ms
customer-seats 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
subscription_id4 / 4
#validinvalidschema
1254100{
2254100 "anyOf": [
3251103 {
4251100 "format": "uuid4",
5351n/a "type": "string"
6251103 },
73351 {
83351 "type": "null"
93351 }
10254100 ],
11254100}
order_id4 / 4
193186{
293186 "anyOf": [
381198 {
481186 "format": "uuid4",
5267n/a "type": "string"
681198 },
712267 {
812267 "type": "null"
912267 }
1093186 ],
1193186}
Responses
codedescriptionhitsavg
200Successful Response0never seen
401Authentication required0never seen
403Not permitted or seat-based pricing not enabled633ms
404Subscription or order not found22510ms
422Validation Error1987ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request857ms
Body
application/json30 / 30
SeatAssign
#validinvalidschema
121851{
221646 "properties": {
32356 "checkout_id": {
42356 "anyOf": [
52329 {
62322 "format": "uuid",
72347 "type": "string"
82329 },
93238 {
103238 "type": "null"
113238 }
122356 ],
132356 },
141476 "customer_id": {
151476 "anyOf": [
1610053 {
171002 "format": "uuid",
1810251 "type": "string"
1910053 },
2047106 {
2147106 "type": "null"
2247106 }
231476 ],
241476 },
251376 "email": {
261376 "anyOf": [
2712221 {
281412 "format": "email",
2912419 "type": "string"
3012221 },
3115128 {
3215128 "type": "null"
3315128 }
341376 ],
351376 },
361426 "external_customer_id": {
371426 "anyOf": [
386286 {
396286 "type": "string"
406286 },
418068 {
428068 "type": "null"
438068 }
441426 ],
451426 },
461575 "immediate_claim": {
471575 "type": "boolean"
481575 },
491424 "metadata": {
501424 "anyOf": [
5139107 {
521n/a "additionalProperties": true,
5339107 "type": "object"
5439107 },
5510343 {
5610343 "type": "null"
5710343 }
581424 ],
591424 },
601386 "order_id": {
611386 "anyOf": [
6211826 {
631182 "format": "uuid",
6412024 "type": "string"
6511826 },
6620124 {
6720124 "type": "null"
6820124 }
691386 ],
701386 },
712077 "subscription_id": {
722077 "anyOf": [
7319123 {
741912 "format": "uuid",
7519321 "type": "string"
7619123 },
7716198 {
7816198 "type": "null"
7916198 }
802077 ],
812077 }
8221646 },
832645 "type": "object"
8421851}
Responses
codedescriptionhitsavg
200Successful Response0never seen
400No available seats or customer already has a seat1165ms
401Authentication required for direct subscription or order assignment0never seen
403Not permitted or seat-based pricing not enabled0never seen
404Subscription, order, checkout, or customer not found617ms
422Validation Error3615ms
Examples
Body: application/json
falseSeatAssign.immediate_claim
Body
application/json4 / 4
SeatClaim
#validinvalidschema
1256282{
225615 "properties": {
325615 "invitation_token": {
425615 "type": "string"
525615 }
625615 },
7271235 "required": [
8271235 "invitation_token"
9271235 ],
1050632 "type": "object"
11256282}
Responses
codedescriptionhitsavg
200Successful Response0never seen
400Invalid, expired, or already claimed token2666ms
403Seat-based pricing not enabled for organization0never seen
422Validation Error4413ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error41952ms
Path Parameters
invitation_token1 / 1
#validinvalidschema
1447n/a{
2447n/a "type": "string"
3447n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
400Invalid or expired invitation token0never seen
403Seat-based pricing not enabled for organization0never seen
404Seat not found4474ms
422Validation Error0never seen
Path Parameters
seat_id2 / 2
#validinvalidschema
134855{
234855 "format": "uuid4",
3403n/a "type": "string"
434855}
Responses
codedescriptionhitsavg
200Successful Response0never seen
401Authentication required0never seen
403Not permitted or seat-based pricing not enabled413ms
404Seat not found3078ms
422Validation Error555ms
Path Parameters
seat_id2 / 2
#validinvalidschema
149150{
249150 "format": "uuid4",
3541n/a "type": "string"
449150}
Responses
codedescriptionhitsavg
200Successful Response0never seen
400Seat is not pending or already claimed0never seen
401Authentication required0never seen
403Not permitted or seat-based pricing not enabled452ms
404Seat not found4468ms
422Validation Error505ms
customer-sessions 1 operation 1 covered 0 partial 0 uncovered 0 not measured 100% #
Body
application/json24 / 24
#validinvalidschema
133579{
233579 "anyOf": [
3188226 {
5188226 },
6147267 {
8147267 }
933579 ],
1033579}
Referenced Components (2)27 of 27 keywords
CustomerSessionCustomerExternalIDCreate13 of 13 keywords
1147267{
220449 "properties": {
31579 "external_customer_id": {
41579 "type": "string"
51579 },
613144 "return_url": {
713144 "anyOf": [
810570 {
910712 "format": "uri",
101163 "maxLength": 2083,
111136 "minLength": 1,
1211956 "type": "string"
1310570 },
1426149 {
1526149 "type": "null"
1626149 }
1713144 ],
1813144 }
1920449 },
20166227 "required": [
21166227 "external_customer_id"
22166227 ],
2339321 "type": "object"
24147267}
CustomerSessionCustomerIDCreate14 of 14 keywords
1188226{
226351 "properties": {
319728 "customer_id": {
419711 "format": "uuid4",
520817 "type": "string"
619728 },
713144 "return_url": {
813144 "anyOf": [
910570 {
1010712 "format": "uri",
111163 "maxLength": 2083,
121136 "minLength": 1,
1311956 "type": "string"
1410570 },
1526149 {
1626149 "type": "null"
1726149 }
1813144 ],
1913144 }
2026351 },
21225168 "required": [
22225168 "customer_id"
23225168 ],
2439321 "type": "object"
25188226}
Responses
codedescriptionhitsavg
201Customer session created.0never seen
422Validation Error3988ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request76ms
401Unauthorized462ms
500Internal Server Error21558ms
Examples
Body: application/json
"https://example.com/account"CustomerSessionCustomerIDCreate.return_url.examples[0]
"https://example.com/account"CustomerSessionCustomerExternalIDCreate.return_url.examples[0]
customers 11 operations 4 covered 5 partial 2 uncovered 0 not measured 87% #
Query Parameters
organization_id2 / 7
#validinvalidschema
16520{
26520 "anyOf": [
30652 {
400 "format": "uuid4",
50n/a "type": "string",
60652 },
76520 {
86520 "items": {
96520 "format": "uuid4",
10652n/a "type": "string",
116520 },
126520 "type": "array"
136520 },
140652 {
150652 "type": "null"
160652 }
176520 ],
186520}
email3 / 3
1300n/a{
2300n/a "anyOf": [
3263n/a {
4263n/a "type": "string"
5263n/a },
637263 {
737263 "type": "null"
837263 }
9300n/a ],
10300n/a}
query3 / 3
1248n/a{
2248n/a "anyOf": [
3212n/a {
4212n/a "type": "string"
5212n/a },
636212 {
736212 "type": "null"
836212 }
9248n/a ],
10248n/a}
include_members1 / 1
130321{
230321 "type": "boolean"
330321}
page2 / 2
127930{
227910 "exclusiveMinimum": 0,
328920 "type": "integer"
427930}
limit2 / 2
123377{
223315 "exclusiveMinimum": 0,
324862 "type": "integer"
423377}
sorting4 / 6
116957{
216957 "anyOf": [
316957 {
416957 "items": {
616957 },
72260 "type": "array"
816957 },
90226 {
100226 "type": "null"
110226 }
1216957 ],
1316957}
Referenced Components (1)3 of 3 keywords
CustomerSortProperty3 of 3 keywords
1699110{
2699110 "enum": [
3105n/a "created_at",
4123n/a "-created_at",
5108n/a "email",
6109n/a "-email",
7118n/a "name",
8136n/a "-name"
9699110 ],
10768n/a "type": "string"
11699110}
metadata4 / 13
MetadataQuery
11610{
21610 "anyOf": [
31610 {
41610 "additionalProperties": {
510370 "anyOf": [
695780 {
795780 "type": "string"
895780 },
901037 {
1001037 "type": "integer"
1101037 },
1201037 {
1301037 "type": "boolean"
1401037 },
1580957 {
16800 "items": {
177060 "type": "string"
18800 },
1980957 "type": "array"
2080957 },
2101037 {
22080 "items": {
230706 "type": "integer"
24080 },
2580957 "type": "array"
2601037 },
2701037 {
28080 "items": {
290706 "type": "boolean"
30080 },
3180957 "type": "array"
3201037 }
3310370 ]
341610 },
351610 "type": "object"
361610 },
370161 {
380161 "type": "null"
390161 }
401610 ],
411610}
Responses
codedescriptionhitsavg
200Successful Response4678ms
422Validation Error1215ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized483ms
500Internal Server Error161668ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
falseinclude_members
1page
10limit
[ "-created_at" ]sorting
Query Parameters
include_members1 / 1
#validinvalidschema
145222{
245222 "type": "boolean"
345222}
Body
application/json73 / 76
CustomerCreate
1538114{
2541106 "properties": {
341734 "billing_address": {
441734 "anyOf": [
5291160 {
7291160 },
8126325 {
9126325 "type": "null"
10126325 }
1141734 ]
1241734 },
1363311 "email": {
146386 "format": "email",
156395 "type": "string"
1663311 },
174514 "external_id": {
184514 "anyOf": [
1944312 {
2044312 "type": "string"
2144312 },
228447 {
238447 "type": "null"
248447 }
254514 ],
264514 },
275067 "metadata": {
281002 "additionalProperties": {
292662 "anyOf": [
3053215 {
31550 "maxLength": 500,
32532 "minLength": 1,
3355213 "type": "string"
3453215 },
3528240 {
3628240 "type": "integer"
3728240 },
3841227 {
3941227 "type": "number"
4041227 },
4117296 {
4217296 "type": "boolean"
4317296 }
442662 ]
451002 },
465080 "maxProperties": 50,
471002 "propertyNames": {
482671 "maxLength": 40,
492671 "minLength": 1
501002 },
515085 "type": "object"
525067 },
534459 "name": {
544459 "anyOf": [
5543717 {
564371 "maxLength": 256,
5743816 "type": "string"
5843717 },
598446 {
608446 "type": "null"
618446 }
624459 ],
634459 },
646334 "organization_id": {
656334 "anyOf": [
666325 {
676320 "format": "uuid4",
686325 "type": "string",
696325 },
701636 {
711636 "type": "null"
721636 }
736334 ],
746334 },
7543519 "owner": {
7643519 "anyOf": [
7743411 {
7943411 },
8039262 {
8139262 "type": "null"
8239262 }
8343519 ],
8443519 },
8543318 "tax_id": {
8643318 "anyOf": [
8741239 {
884251 "maxItems": 2,
894251 "minItems": 2,
9041412 "prefixItems": [
914206 {
924206 "type": "string"
934206 },
944187 {
964187 }
9741412 ],
9842625 "type": "array"
9941239 },
10021430 {
10121430 "type": "null"
10221430 }
10343318 ],
10443318 }
105541106 },
1066443 "required": [
1076443 "email"
1086443 ],
1096475 "type": "object"
110538114}
Referenced Components (3)48 of 48 keywords
AddressInput28 of 28 keywords
1291160{
229228 "properties": {
33044 "city": {
43044 "anyOf": [
510298 {
610298 "type": "string"
710298 },
829414 {
929414 "type": "null"
1029414 }
113044 ],
123044 },
133136 "country": {
143136 "enum": [
156n/a "AD",
162n/a "AE",
171n/a "AF",
181n/a "AG",
191n/a "AI",
201n/a "AL",
211n/a "AM",
221n/a "AO",
231n/a "AQ",
241n/a "AR",
251n/a "AS",
261n/a "AT",
271n/a "AU",
281n/a "AW",
291n/a "AX",
301n/a "AZ",
311n/a "BA",
321n/a "BB",
331n/a "BD",
341n/a "BE",
351n/a "BF",
361n/a "BG",
371n/a "BH",
381n/a "BI",
391n/a "BJ",
401n/a "BL",
411n/a "BM",
421n/a "BN",
431n/a "BO",
441n/a "BQ",
451n/a "BR",
461n/a "BS",
471n/a "BT",
481n/a "BV",
491n/a "BW",
501n/a "BY",
511n/a "BZ",
521n/a "CA",
531n/a "CC",
541n/a "CD",
551n/a "CF",
561n/a "CG",
571n/a "CH",
581n/a "CI",
591n/a "CK",
601n/a "CL",
611n/a "CM",
621n/a "CN",
631n/a "CO",
641n/a "CR",
652n/a "CV",
661n/a "CW",
671n/a "CX",
681n/a "CY",
691n/a "CZ",
701n/a "DE",
711n/a "DJ",
721n/a "DK",
731n/a "DM",
741n/a "DO",
751n/a "DZ",
761n/a "EC",
771n/a "EE",
781n/a "EG",
791n/a "EH",
803n/a "ER",
811n/a "ES",
821n/a "ET",
831n/a "FI",
841n/a "FJ",
851n/a "FK",
861n/a "FM",
876n/a "FO",
882n/a "FR",
891n/a "GA",
901n/a "GB",
911n/a "GD",
921n/a "GE",
931n/a "GF",
941n/a "GG",
951n/a "GH",
961n/a "GI",
971n/a "GL",
981n/a "GM",
991n/a "GN",
1001n/a "GP",
1011n/a "GQ",
1021n/a "GR",
1031n/a "GS",
1041n/a "GT",
1051n/a "GU",
1061n/a "GW",
1071n/a "GY",
1081n/a "HK",
1091n/a "HM",
1101n/a "HN",
1111n/a "HR",
1121n/a "HT",
1131n/a "HU",
1141n/a "ID",
1151n/a "IE",
1161n/a "IL",
1171n/a "IM",
1181n/a "IN",
1191n/a "IO",
1201n/a "IQ",
1211n/a "IS",
1221n/a "IT",
1231n/a "JE",
1241n/a "JM",
1251n/a "JO",
1261n/a "JP",
1271n/a "KE",
1281n/a "KG",
1291n/a "KH",
1301n/a "KI",
1311n/a "KM",
1321n/a "KN",
1331n/a "KR",
1341n/a "KW",
1351n/a "KY",
1361n/a "KZ",
1371n/a "LA",
1381n/a "LB",
1391n/a "LC",
1401n/a "LI",
1411n/a "LK",
1421n/a "LR",
1431n/a "LS",
1441n/a "LT",
1451n/a "LU",
1461n/a "LV",
1471n/a "LY",
1481n/a "MA",
1492n/a "MC",
1502n/a "MD",
1511n/a "ME",
1521n/a "MF",
1531n/a "MG",
1541n/a "MH",
1551n/a "MK",
1561n/a "ML",
1571n/a "MM",
1581n/a "MN",
1591n/a "MO",
1601n/a "MP",
1611n/a "MQ",
1621n/a "MR",
1631n/a "MS",
1641n/a "MT",
1651n/a "MU",
1661n/a "MV",
1671n/a "MW",
1681n/a "MX",
1691n/a "MY",
1701n/a "MZ",
1711n/a "NA",
1721n/a "NC",
1731n/a "NE",
1741n/a "NF",
1751n/a "NG",
1763n/a "NI",
1771n/a "NL",
1781n/a "NO",
1791n/a "NP",
1801n/a "NR",
1811n/a "NU",
1821n/a "NZ",
1831n/a "OM",
1841n/a "PA",
1851n/a "PE",
1861n/a "PF",
1871n/a "PG",
1881n/a "PH",
1891n/a "PK",
1901n/a "PL",
1911n/a "PM",
1921n/a "PN",
1931n/a "PR",
1941n/a "PS",
1951n/a "PT",
1961n/a "PW",
1971n/a "PY",
1981n/a "QA",
1991n/a "RE",
2001n/a "RO",
2011n/a "RS",
2021n/a "RW",
2031n/a "SA",
2041n/a "SB",
2051n/a "SC",
2061n/a "SD",
2072n/a "SE",
2081n/a "SG",
2092n/a "SH",
2101n/a "SI",
2119n/a "SJ",
2121n/a "SK",
2131n/a "SL",
2141n/a "SM",
2151n/a "SN",
2161n/a "SO",
2171n/a "SR",
2181n/a "SS",
2191n/a "ST",
2201n/a "SV",
2211n/a "SX",
2221n/a "SZ",
2231n/a "TC",
2241n/a "TD",
2251n/a "TF",
2261n/a "TG",
2271n/a "TH",
2281n/a "TJ",
2291n/a "TK",
2301n/a "TL",
2312n/a "TM",
2321n/a "TN",
2331n/a "TO",
2341n/a "TR",
2351n/a "TT",
2362n/a "TV",
2371n/a "TW",
2381n/a "TZ",
2391n/a "UA",
2401n/a "UG",
2411n/a "UM",
24236n/a "US",
2431n/a "UY",
2441n/a "UZ",
2451n/a "VA",
2461n/a "VC",
2471n/a "VE",
2481n/a "VG",
2491n/a "VI",
2501n/a "VN",
2511n/a "VU",
2524n/a "WF",
2531n/a "WS",
2541n/a "YE",
2551n/a "YT",
2561n/a "ZA",
2571n/a "ZM",
2581n/a "ZW"
2593136 ],
2603145 "type": "string",
2613136 },
2622944 "line1": {
2632944 "anyOf": [
2648290 {
2658290 "type": "string"
2668290 },
26728612 {
26828612 "type": "null"
26928612 }
2702944 ],
2712944 },
2723014 "line2": {
2733014 "anyOf": [
2749296 {
2759296 "type": "string"
2769296 },
27729213 {
27829213 "type": "null"
27929213 }
2803014 ],
2813014 },
2822994 "postal_code": {
2832994 "anyOf": [
28412291 {
28512291 "type": "string"
28612291 },
28728716 {
28828716 "type": "null"
28928716 }
2902994 ],
2912994 },
2923046 "state": {
2933046 "anyOf": [
2949301 {
2959301 "type": "string"
2969301 },
29729515 {
29829515 "type": "null"
29929515 }
3003046 ],
3013046 }
30229228 },
3033192 "required": [
3043192 "country"
3053192 ],
306321130 "type": "object"
307291160}
OwnerCreate17 of 17 keywords
143411{
22915 "properties": {
3356 "email": {
4356 "anyOf": [
5338 {
6392 "format": "email",
7356 "type": "string"
8338 },
9239 {
10239 "type": "null"
11239 }
12356 ],
13356 },
14374 "external_id": {
15374 "anyOf": [
16347 {
17347 "type": "string"
18347 },
19338 {
20338 "type": "null"
21338 }
22374 ],
23374 },
24365 "name": {
25365 "anyOf": [
262714 {
27271 "maxLength": 256,
282813 "type": "string"
292714 },
30932 {
31932 "type": "null"
32932 }
33365 ],
34365 }
352915 },
3658396 "type": "object"
3743411}
TaxIDFormat3 of 3 keywords
14187{
24187 "enum": [
35n/a "ad_nrt",
40n/a "ae_trn",
51n/a "ar_cuit",
60n/a "au_abn",
73n/a "au_arn",
80n/a "bg_uic",
90n/a "bh_vat",
100n/a "bo_tin",
110n/a "br_cnpj",
120n/a "br_cpf",
13379n/a "ca_bn",
140n/a "ca_gst_hst",
150n/a "ca_pst_bc",
160n/a "ca_pst_mb",
171n/a "ca_pst_sk",
180n/a "ca_qst",
190n/a "ch_uid",
200n/a "ch_vat",
214n/a "cl_tin",
221n/a "cn_tin",
231n/a "co_nit",
240n/a "cr_tin",
250n/a "de_stn",
260n/a "do_rcn",
270n/a "ec_ruc",
280n/a "eg_tin",
290n/a "es_cif",
301n/a "eu_oss_vat",
312n/a "eu_vat",
320n/a "gb_vat",
330n/a "ge_vat",
343n/a "hk_br",
350n/a "hr_oib",
363n/a "hu_tin",
370n/a "id_npwp",
380n/a "il_vat",
390n/a "in_gst",
400n/a "is_vat",
410n/a "jp_cn",
421n/a "jp_rn",
434n/a "jp_trn",
440n/a "ke_pin",
451n/a "kr_brn",
460n/a "kz_bin",
470n/a "li_uid",
483n/a "mx_rfc",
490n/a "my_frp",
500n/a "my_itn",
510n/a "my_sst",
521n/a "ng_tin",
530n/a "no_vat",
540n/a "no_voec",
550n/a "nz_gst",
560n/a "om_vat",
570n/a "pe_ruc",
580n/a "ph_tin",
590n/a "ro_tin",
600n/a "rs_pib",
610n/a "ru_inn",
620n/a "ru_kpp",
630n/a "sa_vat",
640n/a "sg_gst",
650n/a "sg_uen",
660n/a "si_tin",
670n/a "sv_nit",
680n/a "th_vat",
690n/a "tr_tin",
700n/a "tw_vat",
710n/a "ua_vat",
723n/a "us_ein",
731n/a "uy_ruc",
740n/a "ve_rif",
750n/a "vn_tin",
760n/a "za_vat"
774187 ],
784196 "type": "string"
794187}
Responses
codedescriptionhitsavg
201Customer created.3197ms
422Validation Error64349ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error5818ms
401Unauthorized153ms
400Bad Request65ms
Examples
Body: application/json
"US"AddressInput.country.examples[0]
"SE"AddressInput.country.examples[1]
"FR"AddressInput.country.examples[2]
"customer@example.com"CustomerCreate.email.examples[0]
"usr_1337"CustomerCreate.external_id.examples[0]
"John Doe"CustomerCreate.name.examples[0]
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"CustomerCreate.organization_id.examples[0]
"member@example.com"OwnerCreate.email.examples[0]
"usr_1337"OwnerCreate.external_id.examples[0]
"Jane Doe"OwnerCreate.name.examples[0]
[ "911144442", "us_ein" ]CustomerCreate.tax_id.examples[0]
[ "FR61954506077", "eu_vat" ]CustomerCreate.tax_id.examples[1]
Query
falseinclude_members
Query Parameters
organization_id2 / 7
#validinvalidschema
14660{
24660 "anyOf": [
30466 {
400 "format": "uuid4",
50n/a "type": "string",
60466 },
74660 {
84660 "items": {
94660 "format": "uuid4",
10466n/a "type": "string",
114660 },
124660 "type": "array"
134660 },
140466 {
150466 "type": "null"
160466 }
174660 ],
184660}
Responses
codedescriptionhitsavg
200Successful Response616ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4052ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
Path Parameters
external_idno coverage data
#validinvalidschema
10n/a{
20n/a "type": "string"
30n/a}
Expected Responses
codedescriptionhitsavg
204Customer deleted.0never seen
404Customer not found.0never seen
422Validation Error0never seen
Path Parameters
external_id1 / 1
#validinvalidschema
1440n/a{
2440n/a "type": "string"
3440n/a}
Query Parameters
include_members1 / 1
192210{
292210 "type": "boolean"
392210}
Responses
codedescriptionhitsavg
200Successful Response1606ms
404Customer not found.276ms
422Validation Error2105ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized432ms
Examples
Query
falseinclude_members
Path Parameters
external_id1 / 1
#validinvalidschema
1701n/a{
2701n/a "type": "string"
3701n/a}
Query Parameters
include_members1 / 1
147958{
247958 "type": "boolean"
347958}
Body
application/json53 / 54
CustomerUpdateExternalID
1521152{
2407134 "properties": {
340587 "billing_address": {
440587 "anyOf": [
5304188 {
7304188 },
8101391 {
9101391 "type": "null"
10101391 }
1140587 ]
1240587 },
1345115 "email": {
1445115 "anyOf": [
1543531 {
164642 "format": "email",
1743729 "type": "string"
1843531 },
1916450 {
2016450 "type": "null"
2116450 }
2245115 ],
2345115 },
2445522 "metadata": {
257812 "additionalProperties": {
2624637 "anyOf": [
2796187 {
281116 "maxLength": 500,
2910215 "minLength": 1,
30117166 "type": "string"
3196187 },
3239244 {
3339244 "type": "integer"
3439244 },
3562221 {
3662221 "type": "number"
3762221 },
3888195 {
3988195 "type": "boolean"
4088195 }
4124637 ]
427812 },
434700 "maxProperties": 50,
44855 "propertyNames": {
452803 "maxLength": 40,
462812 "minLength": 1
47855 },
484707 "type": "object"
4945522 },
5045320 "name": {
5145320 "anyOf": [
5243538 {
534354 "maxLength": 256,
5443934 "type": "string"
5543538 },
5618455 {
5718455 "type": "null"
5818455 }
5945320 ],
6045320 },
6142235 "tax_id": {
6242235 "anyOf": [
6339562 {
6441115 "maxItems": 2,
654242 "minItems": 2,
6639828 "prefixItems": [
6740322 {
6840322 "type": "string"
6940322 },
7040123 {
7240123 }
7339828 ],
7442631 "type": "array"
7539562 },
7627430 {
7727430 "type": "null"
7827430 }
7942235 ],
8042235 }
81407134 },
8265518 "type": "object"
83521152}
Referenced Components (2)31 of 31 keywords
AddressInput28 of 28 keywords
1304188{
230775 "properties": {
332610 "city": {
432610 "anyOf": [
514322 {
614322 "type": "string"
714322 },
831224 {
931224 "type": "null"
1031224 }
1132610 ],
1232610 },
133736 "country": {
143736 "enum": [
151n/a "AD",
162n/a "AE",
171n/a "AF",
181n/a "AG",
191n/a "AI",
201n/a "AL",
211n/a "AM",
221n/a "AO",
231n/a "AQ",
241n/a "AR",
251n/a "AS",
261n/a "AT",
271n/a "AU",
282n/a "AW",
292n/a "AX",
302n/a "AZ",
311n/a "BA",
321n/a "BB",
331n/a "BD",
341n/a "BE",
351n/a "BF",
361n/a "BG",
371n/a "BH",
381n/a "BI",
391n/a "BJ",
401n/a "BL",
411n/a "BM",
421n/a "BN",
431n/a "BO",
441n/a "BQ",
451n/a "BR",
461n/a "BS",
472n/a "BT",
481n/a "BV",
491n/a "BW",
501n/a "BY",
511n/a "BZ",
521n/a "CA",
531n/a "CC",
541n/a "CD",
551n/a "CF",
561n/a "CG",
571n/a "CH",
581n/a "CI",
591n/a "CK",
601n/a "CL",
611n/a "CM",
621n/a "CN",
631n/a "CO",
641n/a "CR",
651n/a "CV",
661n/a "CW",
671n/a "CX",
681n/a "CY",
691n/a "CZ",
701n/a "DE",
711n/a "DJ",
721n/a "DK",
731n/a "DM",
741n/a "DO",
751n/a "DZ",
761n/a "EC",
774n/a "EE",
781n/a "EG",
791n/a "EH",
801n/a "ER",
811n/a "ES",
822n/a "ET",
831n/a "FI",
841n/a "FJ",
851n/a "FK",
861n/a "FM",
871n/a "FO",
883n/a "FR",
892n/a "GA",
901n/a "GB",
911n/a "GD",
921n/a "GE",
933n/a "GF",
941n/a "GG",
951n/a "GH",
961n/a "GI",
971n/a "GL",
984n/a "GM",
991n/a "GN",
1001n/a "GP",
1011n/a "GQ",
1023n/a "GR",
1031n/a "GS",
1041n/a "GT",
1052n/a "GU",
1061n/a "GW",
1071n/a "GY",
1081n/a "HK",
1091n/a "HM",
1101n/a "HN",
1111n/a "HR",
1121n/a "HT",
1131n/a "HU",
1141n/a "ID",
1151n/a "IE",
1161n/a "IL",
1171n/a "IM",
11818n/a "IN",
1191n/a "IO",
1201n/a "IQ",
1211n/a "IS",
1221n/a "IT",
1231n/a "JE",
1241n/a "JM",
1251n/a "JO",
1261n/a "JP",
1271n/a "KE",
1281n/a "KG",
1291n/a "KH",
1301n/a "KI",
1311n/a "KM",
1321n/a "KN",
1332n/a "KR",
1341n/a "KW",
1351n/a "KY",
1361n/a "KZ",
1371n/a "LA",
1381n/a "LB",
1391n/a "LC",
1401n/a "LI",
1411n/a "LK",
1421n/a "LR",
1431n/a "LS",
1441n/a "LT",
1451n/a "LU",
1461n/a "LV",
1477n/a "LY",
1481n/a "MA",
1491n/a "MC",
1501n/a "MD",
1513n/a "ME",
1521n/a "MF",
1531n/a "MG",
1541n/a "MH",
1551n/a "MK",
1561n/a "ML",
1572n/a "MM",
1581n/a "MN",
1592n/a "MO",
1601n/a "MP",
1611n/a "MQ",
1621n/a "MR",
1631n/a "MS",
1641n/a "MT",
1652n/a "MU",
1661n/a "MV",
1671n/a "MW",
1681n/a "MX",
1693n/a "MY",
1701n/a "MZ",
1711n/a "NA",
1721n/a "NC",
1731n/a "NE",
1741n/a "NF",
1751n/a "NG",
1761n/a "NI",
1771n/a "NL",
1781n/a "NO",
1791n/a "NP",
1801n/a "NR",
1811n/a "NU",
1822n/a "NZ",
1831n/a "OM",
1841n/a "PA",
1851n/a "PE",
1861n/a "PF",
1871n/a "PG",
1881n/a "PH",
1891n/a "PK",
1901n/a "PL",
1911n/a "PM",
1921n/a "PN",
1931n/a "PR",
1941n/a "PS",
1952n/a "PT",
1961n/a "PW",
1971n/a "PY",
1981n/a "QA",
1991n/a "RE",
2001n/a "RO",
2011n/a "RS",
2021n/a "RW",
2031n/a "SA",
2041n/a "SB",
2052n/a "SC",
2061n/a "SD",
2073n/a "SE",
2082n/a "SG",
2091n/a "SH",
2101n/a "SI",
2111n/a "SJ",
2122n/a "SK",
2131n/a "SL",
2142n/a "SM",
21512n/a "SN",
2161n/a "SO",
2173n/a "SR",
2181n/a "SS",
2191n/a "ST",
2201n/a "SV",
2211n/a "SX",
2221n/a "SZ",
2235n/a "TC",
2241n/a "TD",
2251n/a "TF",
2261n/a "TG",
2271n/a "TH",
2281n/a "TJ",
2291n/a "TK",
2301n/a "TL",
2311n/a "TM",
2321n/a "TN",
2331n/a "TO",
2341n/a "TR",
2351n/a "TT",
2361n/a "TV",
2371n/a "TW",
2381n/a "TZ",
2391n/a "UA",
2401n/a "UG",
2411n/a "UM",
24236n/a "US",
2431n/a "UY",
24417n/a "UZ",
2451n/a "VA",
2461n/a "VC",
2471n/a "VE",
2483n/a "VG",
2491n/a "VI",
2501n/a "VN",
2511n/a "VU",
2521n/a "WF",
2531n/a "WS",
2541n/a "YE",
2551n/a "YT",
2561n/a "ZA",
2571n/a "ZM",
2581n/a "ZW"
2593736 ],
2603745 "type": "string",
2613736 },
26232427 "line1": {
26332427 "anyOf": [
26413338 {
26513338 "type": "string"
26613338 },
26731140 {
26831140 "type": "null"
26931140 }
27032427 ],
27132427 },
27233216 "line2": {
27333216 "anyOf": [
27433315 {
27533315 "type": "string"
27633315 },
27729949 {
27829949 "type": "null"
27929949 }
28033216 ],
28133216 },
2823269 "postal_code": {
2833269 "anyOf": [
28423312 {
28523312 "type": "string"
28623312 },
28730332 {
28830332 "type": "null"
28930332 }
2903269 ],
2913269 },
29233310 "state": {
29333310 "anyOf": [
29421322 {
29521322 "type": "string"
29621322 },
29731231 {
29831231 "type": "null"
29931231 }
30033310 ],
30133310 }
30230775 },
3033794 "required": [
3043794 "country"
3053794 ],
306383109 "type": "object"
307304188}
TaxIDFormat3 of 3 keywords
140123{
240123 "enum": [
35n/a "ad_nrt",
41n/a "ae_trn",
50n/a "ar_cuit",
60n/a "au_abn",
70n/a "au_arn",
82n/a "bg_uic",
90n/a "bh_vat",
100n/a "bo_tin",
111n/a "br_cnpj",
120n/a "br_cpf",
13327n/a "ca_bn",
142n/a "ca_gst_hst",
150n/a "ca_pst_bc",
162n/a "ca_pst_mb",
170n/a "ca_pst_sk",
183n/a "ca_qst",
190n/a "ch_uid",
200n/a "ch_vat",
210n/a "cl_tin",
220n/a "cn_tin",
230n/a "co_nit",
240n/a "cr_tin",
250n/a "de_stn",
261n/a "do_rcn",
2718n/a "ec_ruc",
280n/a "eg_tin",
292n/a "es_cif",
300n/a "eu_oss_vat",
312n/a "eu_vat",
320n/a "gb_vat",
331n/a "ge_vat",
341n/a "hk_br",
350n/a "hr_oib",
360n/a "hu_tin",
370n/a "id_npwp",
380n/a "il_vat",
390n/a "in_gst",
400n/a "is_vat",
4112n/a "jp_cn",
420n/a "jp_rn",
430n/a "jp_trn",
440n/a "ke_pin",
450n/a "kr_brn",
468n/a "kz_bin",
470n/a "li_uid",
480n/a "mx_rfc",
491n/a "my_frp",
500n/a "my_itn",
510n/a "my_sst",
521n/a "ng_tin",
530n/a "no_vat",
542n/a "no_voec",
550n/a "nz_gst",
561n/a "om_vat",
570n/a "pe_ruc",
580n/a "ph_tin",
590n/a "ro_tin",
601n/a "rs_pib",
610n/a "ru_inn",
621n/a "ru_kpp",
630n/a "sa_vat",
640n/a "sg_gst",
651n/a "sg_uen",
660n/a "si_tin",
670n/a "sv_nit",
680n/a "th_vat",
690n/a "tr_tin",
700n/a "tw_vat",
710n/a "ua_vat",
723n/a "us_ein",
732n/a "uy_ruc",
740n/a "ve_rif",
750n/a "vn_tin",
760n/a "za_vat"
7740123 ],
7840222 "type": "string"
7940123}
Responses
codedescriptionhitsavg
200Customer updated.14418ms
404Customer not found.137ms
422Validation Error5087ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error13843ms
401Unauthorized182ms
400Bad Request55ms
Examples
Body: application/json
"US"AddressInput.country.examples[0]
"SE"AddressInput.country.examples[1]
"FR"AddressInput.country.examples[2]
"customer@example.com"CustomerUpdateExternalID.email.examples[0]
"John Doe"CustomerUpdateExternalID.name.examples[0]
[ "911144442", "us_ein" ]CustomerUpdateExternalID.tax_id.examples[0]
[ "FR61954506077", "eu_vat" ]CustomerUpdateExternalID.tax_id.examples[1]
Query
falseinclude_members
Path Parameters
external_id1 / 1
#validinvalidschema
1442n/a{
2442n/a "type": "string"
3442n/a}
Responses
codedescriptionhitsavg
200Successful Response1346ms
404Customer not found.137ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2952ms
Path Parameters
idno coverage data
#validinvalidschema
100{
200 "format": "uuid4",
30n/a "type": "string"
400}
Expected Responses
codedescriptionhitsavg
204Customer deleted.0never seen
404Customer not found.0never seen
422Validation Error0never seen
Path Parameters
id2 / 2
#validinvalidschema
140411{
240411 "format": "uuid4",
3415n/a "type": "string"
440411}
Query Parameters
include_members1 / 1
15428{
25428 "type": "boolean"
35428}
Responses
codedescriptionhitsavg
200Successful Response3296ms
404Customer not found.2619ms
422Validation Error396ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized213ms
Examples
Query
falseinclude_members
Path Parameters
id2 / 2
#validinvalidschema
17251{
27251 "format": "uuid4",
3726n/a "type": "string"
47251}
Query Parameters
include_members1 / 1
142240{
242240 "type": "boolean"
342240}
Body
application/json55 / 57
CustomerUpdate
161096{
237490 "properties": {
339440 "billing_address": {
439440 "anyOf": [
5289145 {
7289145 },
8105329 {
9105329 "type": "null"
10105329 }
1139440 ]
1239440 },
1340810 "email": {
1440810 "anyOf": [
1538929 {
164162 "format": "email",
1739127 "type": "string"
1838929 },
1919399 {
2019399 "type": "null"
2119399 }
2240810 ],
2340810 },
244054 "external_id": {
254054 "anyOf": [
2639118 {
2739118 "type": "string"
2839118 },
2914395 {
3014395 "type": "null"
3114395 }
324054 ],
334054 },
3439419 "metadata": {
353113 "additionalProperties": {
3612243 "anyOf": [
3738127 {
38400 "maxLength": 500,
39382 "minLength": 1,
4040125 "type": "string"
4138127 },
4233132 {
4333132 "type": "integer"
4433132 },
4540125 {
4640125 "type": "number"
4740125 },
4844121 {
4944121 "type": "boolean"
5044121 }
5112243 ]
523113 },
534080 "maxProperties": 50,
54413 "propertyNames": {
551632 "maxLength": 40,
561641 "minLength": 1
57413 },
584085 "type": "object"
5939419 },
603979 "name": {
613979 "anyOf": [
6238224 {
633823 "maxLength": 256,
6438521 "type": "string"
6538224 },
6615391 {
6715391 "type": "null"
6815391 }
693979 ],
703979 },
7138119 "tax_id": {
7238119 "anyOf": [
7335050 {
743632 "maxItems": 2,
753641 "minItems": 2,
7635213 "prefixItems": [
773587 {
783587 "type": "string"
793587 },
803568 {
823568 }
8335213 ],
8436535 "type": "array"
8535050 },
8631369 {
8731369 "type": "null"
8831369 }
8938119 ],
9038119 }
9137490 },
927006 "type": "object"
9361096}
Referenced Components (2)31 of 31 keywords
AddressInput28 of 28 keywords
1289145{
229132 "properties": {
32984 "city": {
42984 "anyOf": [
58294 {
68294 "type": "string"
78294 },
829012 {
929012 "type": "null"
1029012 }
112984 ],
122984 },
133156 "country": {
143156 "enum": [
158n/a "AD",
161n/a "AE",
171n/a "AF",
181n/a "AG",
191n/a "AI",
201n/a "AL",
211n/a "AM",
223n/a "AO",
231n/a "AQ",
241n/a "AR",
251n/a "AS",
262n/a "AT",
271n/a "AU",
281n/a "AW",
291n/a "AX",
301n/a "AZ",
311n/a "BA",
321n/a "BB",
331n/a "BD",
341n/a "BE",
351n/a "BF",
361n/a "BG",
371n/a "BH",
381n/a "BI",
391n/a "BJ",
401n/a "BL",
411n/a "BM",
421n/a "BN",
431n/a "BO",
441n/a "BQ",
451n/a "BR",
461n/a "BS",
471n/a "BT",
481n/a "BV",
491n/a "BW",
501n/a "BY",
511n/a "BZ",
521n/a "CA",
531n/a "CC",
541n/a "CD",
551n/a "CF",
561n/a "CG",
571n/a "CH",
581n/a "CI",
591n/a "CK",
601n/a "CL",
611n/a "CM",
621n/a "CN",
631n/a "CO",
641n/a "CR",
651n/a "CV",
661n/a "CW",
671n/a "CX",
681n/a "CY",
691n/a "CZ",
701n/a "DE",
711n/a "DJ",
721n/a "DK",
731n/a "DM",
741n/a "DO",
751n/a "DZ",
761n/a "EC",
771n/a "EE",
781n/a "EG",
791n/a "EH",
803n/a "ER",
811n/a "ES",
821n/a "ET",
831n/a "FI",
841n/a "FJ",
851n/a "FK",
861n/a "FM",
871n/a "FO",
883n/a "FR",
891n/a "GA",
901n/a "GB",
915n/a "GD",
921n/a "GE",
931n/a "GF",
941n/a "GG",
951n/a "GH",
961n/a "GI",
971n/a "GL",
981n/a "GM",
991n/a "GN",
1001n/a "GP",
1011n/a "GQ",
1021n/a "GR",
1031n/a "GS",
1041n/a "GT",
1052n/a "GU",
1062n/a "GW",
1071n/a "GY",
1081n/a "HK",
1093n/a "HM",
1101n/a "HN",
1111n/a "HR",
1121n/a "HT",
1131n/a "HU",
1142n/a "ID",
1151n/a "IE",
1161n/a "IL",
1171n/a "IM",
1181n/a "IN",
1191n/a "IO",
1201n/a "IQ",
1211n/a "IS",
1222n/a "IT",
1231n/a "JE",
1241n/a "JM",
1251n/a "JO",
1261n/a "JP",
1271n/a "KE",
1281n/a "KG",
1291n/a "KH",
1301n/a "KI",
1311n/a "KM",
1321n/a "KN",
1331n/a "KR",
1341n/a "KW",
1351n/a "KY",
1361n/a "KZ",
1371n/a "LA",
1381n/a "LB",
1391n/a "LC",
1401n/a "LI",
1411n/a "LK",
1421n/a "LR",
1431n/a "LS",
1441n/a "LT",
1451n/a "LU",
1461n/a "LV",
1472n/a "LY",
1481n/a "MA",
1491n/a "MC",
1502n/a "MD",
1511n/a "ME",
1521n/a "MF",
1531n/a "MG",
1541n/a "MH",
1551n/a "MK",
1561n/a "ML",
1571n/a "MM",
1581n/a "MN",
1591n/a "MO",
1601n/a "MP",
1611n/a "MQ",
1621n/a "MR",
1631n/a "MS",
1641n/a "MT",
1651n/a "MU",
1661n/a "MV",
1671n/a "MW",
1681n/a "MX",
1691n/a "MY",
1701n/a "MZ",
1711n/a "NA",
1722n/a "NC",
1731n/a "NE",
1741n/a "NF",
1751n/a "NG",
1761n/a "NI",
1771n/a "NL",
1781n/a "NO",
1791n/a "NP",
1801n/a "NR",
1811n/a "NU",
1821n/a "NZ",
1831n/a "OM",
1841n/a "PA",
1851n/a "PE",
1861n/a "PF",
1871n/a "PG",
1881n/a "PH",
1891n/a "PK",
1901n/a "PL",
1911n/a "PM",
1921n/a "PN",
1931n/a "PR",
1945n/a "PS",
1951n/a "PT",
1961n/a "PW",
1971n/a "PY",
1981n/a "QA",
1991n/a "RE",
2001n/a "RO",
2012n/a "RS",
2021n/a "RW",
2031n/a "SA",
2041n/a "SB",
2051n/a "SC",
2061n/a "SD",
2073n/a "SE",
2081n/a "SG",
2091n/a "SH",
2101n/a "SI",
2111n/a "SJ",
2121n/a "SK",
2131n/a "SL",
2141n/a "SM",
2151n/a "SN",
2161n/a "SO",
2171n/a "SR",
2181n/a "SS",
2191n/a "ST",
2201n/a "SV",
2211n/a "SX",
2221n/a "SZ",
2231n/a "TC",
2241n/a "TD",
2251n/a "TF",
2261n/a "TG",
2271n/a "TH",
2281n/a "TJ",
2291n/a "TK",
2301n/a "TL",
2311n/a "TM",
2321n/a "TN",
2331n/a "TO",
2341n/a "TR",
2351n/a "TT",
2361n/a "TV",
2371n/a "TW",
2381n/a "TZ",
2391n/a "UA",
2401n/a "UG",
2411n/a "UM",
24237n/a "US",
2431n/a "UY",
2441n/a "UZ",
2451n/a "VA",
2461n/a "VC",
2471n/a "VE",
2481n/a "VG",
2491n/a "VI",
2501n/a "VN",
2511n/a "VU",
2521n/a "WF",
2531n/a "WS",
2541n/a "YE",
2551n/a "YT",
2561n/a "ZA",
2572n/a "ZM",
2581n/a "ZW"
2593156 ],
2603165 "type": "string",
2613156 },
2622975 "line1": {
2632975 "anyOf": [
26411291 {
26511291 "type": "string"
26611291 },
26728616 {
26828616 "type": "null"
26928616 }
2702975 ],
2712975 },
2722938 "line2": {
2732938 "anyOf": [
27411290 {
27511290 "type": "string"
27611290 },
27728219 {
27828219 "type": "null"
27928219 }
2802938 ],
2812938 },
2822975 "postal_code": {
2832975 "anyOf": [
2849293 {
2859293 "type": "string"
2869293 },
28728814 {
28828814 "type": "null"
28928814 }
2902975 ],
2912975 },
2922925 "state": {
2932925 "anyOf": [
2943294 {
2953294 "type": "string"
2963294 },
2972898 {
2982898 "type": "null"
2992898 }
3002925 ],
3012925 }
30229132 },
3033214 "required": [
3043214 "country"
3053214 ],
306325109 "type": "object"
307289145}
TaxIDFormat3 of 3 keywords
13568{
23568 "enum": [
36n/a "ad_nrt",
40n/a "ae_trn",
50n/a "ar_cuit",
60n/a "au_abn",
70n/a "au_arn",
80n/a "bg_uic",
90n/a "bh_vat",
100n/a "bo_tin",
111n/a "br_cnpj",
121n/a "br_cpf",
13332n/a "ca_bn",
140n/a "ca_gst_hst",
150n/a "ca_pst_bc",
160n/a "ca_pst_mb",
170n/a "ca_pst_sk",
180n/a "ca_qst",
190n/a "ch_uid",
200n/a "ch_vat",
210n/a "cl_tin",
220n/a "cn_tin",
230n/a "co_nit",
240n/a "cr_tin",
250n/a "de_stn",
260n/a "do_rcn",
270n/a "ec_ruc",
280n/a "eg_tin",
290n/a "es_cif",
300n/a "eu_oss_vat",
313n/a "eu_vat",
320n/a "gb_vat",
330n/a "ge_vat",
340n/a "hk_br",
350n/a "hr_oib",
360n/a "hu_tin",
370n/a "id_npwp",
381n/a "il_vat",
390n/a "in_gst",
400n/a "is_vat",
410n/a "jp_cn",
420n/a "jp_rn",
430n/a "jp_trn",
440n/a "ke_pin",
450n/a "kr_brn",
460n/a "kz_bin",
470n/a "li_uid",
481n/a "mx_rfc",
490n/a "my_frp",
500n/a "my_itn",
510n/a "my_sst",
520n/a "ng_tin",
530n/a "no_vat",
540n/a "no_voec",
550n/a "nz_gst",
560n/a "om_vat",
570n/a "pe_ruc",
580n/a "ph_tin",
590n/a "ro_tin",
600n/a "rs_pib",
610n/a "ru_inn",
621n/a "ru_kpp",
630n/a "sa_vat",
640n/a "sg_gst",
652n/a "sg_uen",
660n/a "si_tin",
670n/a "sv_nit",
680n/a "th_vat",
690n/a "tr_tin",
702n/a "tw_vat",
710n/a "ua_vat",
725n/a "us_ein",
730n/a "uy_ruc",
741n/a "ve_rif",
750n/a "vn_tin",
760n/a "za_vat"
773568 ],
783577 "type": "string"
793568}
Responses
codedescriptionhitsavg
200Customer updated.2578ms
404Customer not found.87ms
422Validation Error4437ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error8834ms
401Unauthorized53ms
400Bad Request55ms
Examples
Body: application/json
"US"AddressInput.country.examples[0]
"SE"AddressInput.country.examples[1]
"FR"AddressInput.country.examples[2]
"customer@example.com"CustomerUpdate.email.examples[0]
"usr_1337"CustomerUpdate.external_id.examples[0]
"John Doe"CustomerUpdate.name.examples[0]
[ "911144442", "us_ein" ]CustomerUpdate.tax_id.examples[0]
[ "FR61954506077", "eu_vat" ]CustomerUpdate.tax_id.examples[1]
Query
falseinclude_members
Path Parameters
id2 / 2
#validinvalidschema
136854{
236854 "format": "uuid4",
3422n/a "type": "string"
436854}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Customer not found.3167ms
422Validation Error545ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized522ms
discounts 5 operations 2 covered 3 partial 0 uncovered 0 not measured 89% #
Query Parameters
organization_id2 / 7
#validinvalidschema
15510{
25510 "anyOf": [
30551 {
400 "format": "uuid4",
50n/a "type": "string",
60551 },
75510 {
85510 "items": {
95510 "format": "uuid4",
10551n/a "type": "string",
115510 },
125510 "type": "array"
135510 },
140551 {
150551 "type": "null"
160551 }
175510 ],
185510}
query3 / 3
1288n/a{
2288n/a "anyOf": [
3198n/a {
4198n/a "type": "string"
5198n/a },
690198 {
790198 "type": "null"
890198 }
9288n/a ],
10288n/a}
page2 / 2
1174135{
217425 "exclusiveMinimum": 0,
3199110 "type": "integer"
4174135}
limit2 / 2
124749{
22473 "exclusiveMinimum": 0,
325046 "type": "integer"
424749}
sorting4 / 6
1112113{
2112113 "anyOf": [
3112113 {
4112113 "items": {
6112113 },
72250 "type": "array"
8112113 },
90225 {
100225 "type": "null"
110225 }
12112113 ],
13112113}
Referenced Components (1)3 of 3 keywords
DiscountSortProperty3 of 3 keywords
1509225{
2509225 "enum": [
370n/a "created_at",
466n/a "-created_at",
561n/a "name",
672n/a "-name",
756n/a "code",
862n/a "-code",
962n/a "redemptions_count",
1060n/a "-redemptions_count"
11509225 ],
12652n/a "type": "string"
13509225}
Responses
codedescriptionhitsavg
200Successful Response2958ms
422Validation Error2248ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized303ms
500Internal Server Error21659ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-created_at" ]sorting
Body
application/json177 / 199
DiscountCreate
#validinvalidschema
1263944{
2263944 "oneOf": [
31661041 {
51661041 },
621205 {
821205 },
91021105 {
111021105 },
1231204 {
1431204 }
15263944 ]
16263944}
Referenced Components (6)210 of 232 keywords
DiscountDuration3 of 3 keywords
14416276{
24416276 "enum": [
34092n/a "once",
4108n/a "forever",
5216n/a "repeating"
64416276 ],
74464228 "type": "string"
84416276}
DiscountFixedOnceForeverDurationCreate52 of 56 keywords
11661041{
2371821 "properties": {
358648 "amount": {
45986 "maximum": 999999999999.0,
55986 "minimum": 0.0,
659836 "type": "integer"
758648 },
8103749 "code": {
9103749 "anyOf": [
10281058 {
11281058 "type": "string"
12281058 },
13100977 {
14100977 "type": "null"
15100977 }
16103749 ],
17103749 },
1852936 "currency": {
195296 "pattern": "usd",
2053530 "type": "string"
2152936 },
22110469 "duration": {
24110469 },
2599073 "ends_at": {
2699073 "anyOf": [
2797984 {
2897924 "format": "date-time",
29100360 "type": "string"
3097984 },
31111052 {
32111052 "type": "null"
33111052 }
3499073 ],
3599073 },
3699176 "max_redemptions": {
3799176 "anyOf": [
38951116 {
3995125 "minimum": 1.0,
40964103 "type": "integer"
41951116 },
42401027 {
43401027 "type": "null"
44401027 }
4599176 ],
4699176 },
4797288 "metadata": {
484225 "additionalProperties": {
4914830 "anyOf": [
5041137 {
51650 "maxLength": 500,
524124 "minLength": 1,
5365113 "type": "string"
5441137 },
5534144 {
5634144 "type": "integer"
5734144 },
5854124 {
5954124 "type": "number"
6054124 },
6153125 {
6253125 "type": "boolean"
6353125 }
6414830 ]
654225 },
669990 "maxProperties": 50,
674126 "propertyNames": {
6816414 "maxLength": 40,
6916612 "minLength": 1
704126 },
7199961 "type": "object"
7297288 },
73109875 "name": {
74109815 "minLength": 1,
75111360 "type": "string"
76109875 },
77110048 "organization_id": {
78110048 "anyOf": [
79109652 {
8010960 "format": "uuid4",
81109652 "type": "string",
82109652 },
8341144 {
8441144 "type": "null"
8541144 }
86110048 ],
87110048 },
88929120 "products": {
89929120 "anyOf": [
90911138 {
9191172 "items": {
921690 "format": "uuid4",
9316984 "type": "string"
9491172 },
9598366 "type": "array"
96911138 },
97181031 {
98181031 "type": "null"
99181031 }
100929120 ],
101929120 },
10297774 "starts_at": {
10397774 "anyOf": [
10496487 {
10596424 "format": "date-time",
10698863 "type": "string"
10796487 },
108131038 {
109131038 "type": "null"
110131038 }
11197774 ],
11297774 },
113110172 "type": {
115110172 }
116371821 },
117616576 "required": [
118117319 "duration",
119117319 "type",
120634558 "amount",
121117319 "name"
122616576 ],
123119215 "type": "object"
1241661041}
DiscountFixedRepeatDurationCreate52 of 59 keywords
121205{
2371821 "properties": {
358648 "amount": {
45986 "maximum": 999999999999.0,
55986 "minimum": 0.0,
659836 "type": "integer"
758648 },
8103749 "code": {
9103749 "anyOf": [
10281058 {
11281058 "type": "string"
12281058 },
13100977 {
14100977 "type": "null"
15100977 }
16103749 ],
17103749 },
1852936 "currency": {
195296 "pattern": "usd",
2053530 "type": "string"
2152936 },
22110469 "duration": {
24110469 },
254620 "duration_in_months": {
264620 "maximum": 999.0,
274620 "minimum": 1.0,
284620 "type": "integer"
294620 },
3099073 "ends_at": {
3199073 "anyOf": [
3297984 {
3397924 "format": "date-time",
34100360 "type": "string"
3597984 },
36111052 {
37111052 "type": "null"
38111052 }
3999073 ],
4099073 },
4199176 "max_redemptions": {
4299176 "anyOf": [
43951116 {
4495125 "minimum": 1.0,
45964103 "type": "integer"
46951116 },
47401027 {
48401027 "type": "null"
49401027 }
5099176 ],
5199176 },
5297288 "metadata": {
534225 "additionalProperties": {
5414830 "anyOf": [
5541137 {
56650 "maxLength": 500,
574124 "minLength": 1,
5865113 "type": "string"
5941137 },
6034144 {
6134144 "type": "integer"
6234144 },
6354124 {
6454124 "type": "number"
6554124 },
6653125 {
6753125 "type": "boolean"
6853125 }
6914830 ]
704225 },
719990 "maxProperties": 50,
724126 "propertyNames": {
7316414 "maxLength": 40,
7416612 "minLength": 1
754126 },
7699961 "type": "object"
7797288 },
78109875 "name": {
79109815 "minLength": 1,
80111360 "type": "string"
81109875 },
82110048 "organization_id": {
83110048 "anyOf": [
84109652 {
8510960 "format": "uuid4",
86109652 "type": "string",
87109652 },
8841144 {
8941144 "type": "null"
9041144 }
91110048 ],
92110048 },
93929120 "products": {
94929120 "anyOf": [
95911138 {
9691172 "items": {
971690 "format": "uuid4",
9816984 "type": "string"
9991172 },
10098366 "type": "array"
101911138 },
102181031 {
103181031 "type": "null"
104181031 }
105929120 ],
106929120 },
10797774 "starts_at": {
10897774 "anyOf": [
10996487 {
11096424 "format": "date-time",
11198863 "type": "string"
11296487 },
113131038 {
114131038 "type": "null"
115131038 }
11697774 ],
11797774 },
118110172 "type": {
120110172 }
121371821 },
122227965 "required": [
123117319 "duration",
124462730 "duration_in_months",
125117319 "type",
126634558 "amount",
127117319 "name"
128227965 ],
129119215 "type": "object"
13021205}
DiscountPercentageOnceForeverDurationCreate50 of 54 keywords
11021105{
2407785 "properties": {
349148 "basis_points": {
45036 "maximum": 10000.0,
549712 "minimum": 1.0,
650336 "type": "integer"
749148 },
8103749 "code": {
9103749 "anyOf": [
10281058 {
11281058 "type": "string"
12281058 },
13100977 {
14100977 "type": "null"
15100977 }
16103749 ],
17103749 },
18110469 "duration": {
20110469 },
2199073 "ends_at": {
2299073 "anyOf": [
2397984 {
2497924 "format": "date-time",
25100360 "type": "string"
2697984 },
27111052 {
28111052 "type": "null"
29111052 }
3099073 ],
3199073 },
3299176 "max_redemptions": {
3399176 "anyOf": [
34951116 {
3595125 "minimum": 1.0,
36964103 "type": "integer"
37951116 },
38401027 {
39401027 "type": "null"
40401027 }
4199176 ],
4299176 },
4397288 "metadata": {
444225 "additionalProperties": {
4514830 "anyOf": [
4641137 {
47650 "maxLength": 500,
484124 "minLength": 1,
4965113 "type": "string"
5041137 },
5134144 {
5234144 "type": "integer"
5334144 },
5454124 {
5554124 "type": "number"
5654124 },
5753125 {
5853125 "type": "boolean"
5953125 }
6014830 ]
614225 },
629990 "maxProperties": 50,
634126 "propertyNames": {
6416414 "maxLength": 40,
6516612 "minLength": 1
664126 },
6799961 "type": "object"
6897288 },
69109875 "name": {
70109815 "minLength": 1,
71111360 "type": "string"
72109875 },
73110048 "organization_id": {
74110048 "anyOf": [
75109652 {
7610960 "format": "uuid4",
77109652 "type": "string",
78109652 },
7941144 {
8041144 "type": "null"
8141144 }
82110048 ],
83110048 },
84929120 "products": {
85929120 "anyOf": [
86911138 {
8791172 "items": {
881690 "format": "uuid4",
8916984 "type": "string"
9091172 },
9198366 "type": "array"
92911138 },
93181031 {
94181031 "type": "null"
95181031 }
96929120 ],
97929120 },
9897774 "starts_at": {
9997774 "anyOf": [
10096487 {
10196424 "format": "date-time",
10298863 "type": "string"
10396487 },
104131038 {
105131038 "type": "null"
106131038 }
10797774 ],
10897774 },
109110172 "type": {
111110172 }
112407785 },
113521671 "required": [
114117319 "duration",
115117319 "type",
116539653 "basis_points",
117117319 "name"
118521671 ],
119119215 "type": "object"
1201021105}
DiscountPercentageRepeatDurationCreate50 of 57 keywords
131204{
2407785 "properties": {
349148 "basis_points": {
45036 "maximum": 10000.0,
549712 "minimum": 1.0,
650336 "type": "integer"
749148 },
8103749 "code": {
9103749 "anyOf": [
10281058 {
11281058 "type": "string"
12281058 },
13100977 {
14100977 "type": "null"
15100977 }
16103749 ],
17103749 },
18110469 "duration": {
20110469 },
214620 "duration_in_months": {
224620 "maximum": 999.0,
234620 "minimum": 1.0,
244620 "type": "integer"
254620 },
2699073 "ends_at": {
2799073 "anyOf": [
2897984 {
2997924 "format": "date-time",
30100360 "type": "string"
3197984 },
32111052 {
33111052 "type": "null"
34111052 }
3599073 ],
3699073 },
3799176 "max_redemptions": {
3899176 "anyOf": [
39951116 {
4095125 "minimum": 1.0,
41964103 "type": "integer"
42951116 },
43401027 {
44401027 "type": "null"
45401027 }
4699176 ],
4799176 },
4897288 "metadata": {
494225 "additionalProperties": {
5014830 "anyOf": [
5141137 {
52650 "maxLength": 500,
534124 "minLength": 1,
5465113 "type": "string"
5541137 },
5634144 {
5734144 "type": "integer"
5834144 },
5954124 {
6054124 "type": "number"
6154124 },
6253125 {
6353125 "type": "boolean"
6453125 }
6514830 ]
664225 },
679990 "maxProperties": 50,
684126 "propertyNames": {
6916414 "maxLength": 40,
7016612 "minLength": 1
714126 },
7299961 "type": "object"
7397288 },
74109875 "name": {
75109815 "minLength": 1,
76111360 "type": "string"
77109875 },
78110048 "organization_id": {
79110048 "anyOf": [
80109652 {
8110960 "format": "uuid4",
82109652 "type": "string",
83109652 },
8441144 {
8541144 "type": "null"
8641144 }
87110048 ],
88110048 },
89929120 "products": {
90929120 "anyOf": [
91911138 {
9291172 "items": {
931690 "format": "uuid4",
9416984 "type": "string"
9591172 },
9698366 "type": "array"
97911138 },
98181031 {
99181031 "type": "null"
100181031 }
101929120 ],
102929120 },
10397774 "starts_at": {
10497774 "anyOf": [
10596487 {
10696424 "format": "date-time",
10798863 "type": "string"
10896487 },
109131038 {
110131038 "type": "null"
111131038 }
11297774 ],
11397774 },
114110172 "type": {
116110172 }
117407785 },
118211981 "required": [
119117319 "duration",
120462730 "duration_in_months",
121117319 "type",
122539653 "basis_points",
123117319 "name"
124211981 ],
125119215 "type": "object"
12631204}
DiscountType3 of 3 keywords
14404288{
24404288 "enum": [
34140n/a "fixed",
4264n/a "percentage"
54404288 ],
64452240 "type": "string"
74404288}
Responses
codedescriptionhitsavg
201Discount created.0never seen
422Validation Error11386ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error681049ms
400Bad Request610ms
401Unauthorized173ms
Examples
Body: application/json
"usd"DiscountFixedOnceForeverDurationCreate.currency
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"DiscountFixedOnceForeverDurationCreate.organization_id.examples[0]
"usd"DiscountFixedRepeatDurationCreate.currency
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"DiscountFixedRepeatDurationCreate.organization_id.examples[0]
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"DiscountPercentageOnceForeverDurationCreate.organization_id.examples[0]
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"DiscountPercentageRepeatDurationCreate.organization_id.examples[0]
Path Parameters
id2 / 2
#validinvalidschema
135350{
235350 "format": "uuid4",
3403n/a "type": "string"
435350}
Responses
codedescriptionhitsavg
204Discount deleted.0never seen
404Discount not found.3186ms
422Validation Error5012ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized352ms
Path Parameters
id2 / 2
#validinvalidschema
135350{
235350 "format": "uuid4",
3403n/a "type": "string"
435350}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Discount not found.3186ms
422Validation Error5013ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized352ms
Path Parameters
id2 / 2
#validinvalidschema
152419{
252419 "format": "uuid4",
3543n/a "type": "string"
452419}
Body
application/json65 / 66
DiscountUpdate
1219111{
213599 "properties": {
31598 "amount": {
41598 "anyOf": [
514720 {
61501 "maximum": 999999999999.0,
71492 "minimum": 0.0,
815017 "type": "integer"
914720 },
1012155 {
1112155 "type": "null"
1212155 }
131598 ],
141598 },
151587 "basis_points": {
161587 "anyOf": [
1714421 {
181461 "maximum": 10000.0,
191452 "minimum": 1.0,
2014619 "type": "integer"
2114421 },
2214151 {
2314151 "type": "null"
2414151 }
251587 ],
261587 },
271657 "code": {
281657 "anyOf": [
2930142 {
3030142 "type": "string"
3130142 },
3213537 {
3313537 "type": "null"
3413537 }
351657 ],
361657 },
371636 "currency": {
381636 "anyOf": [
3914722 {
401472 "pattern": "usd",
4114920 "type": "string"
4214722 },
4316153 {
4416153 "type": "null"
4516153 }
461636 ],
471636 },
481568 "duration": {
491568 "anyOf": [
5039125 {
5239125 },
5311747 {
5411747 "type": "null"
5511747 }
561568 ]
571568 },
581628 "duration_in_months": {
591628 "anyOf": [
6013832 {
611401 "maximum": 999.0,
621392 "minimum": 1.0,
6314030 "type": "integer"
6413832 },
6524146 {
6624146 "type": "null"
6724146 }
681628 ],
691628 },
701506 "ends_at": {
711506 "anyOf": [
7214115 {
731412 "format": "date-time",
7414313 "type": "string"
7514115 },
769147 {
779147 "type": "null"
789147 }
791506 ],
801506 },
811557 "max_redemptions": {
821557 "anyOf": [
8314418 {
841443 "minimum": 1.0,
8514616 "type": "integer"
8614418 },
8711151 {
8811151 "type": "null"
8911151 }
901557 ],
911557 },
9216012 "metadata": {
93326 "additionalProperties": {
9410417 "anyOf": [
954774 {
96491 "maxLength": 500,
97482 "minLength": 1,
985071 "type": "string"
994774 },
1002992 {
1012992 "type": "integer"
1022992 },
1033388 {
1043388 "type": "number"
1053388 },
1062497 {
1072497 "type": "boolean"
1082497 }
10910417 ]
110326 },
1111660 "maxProperties": 50,
112362 "propertyNames": {
1131201 "maxLength": 40,
1141201 "minLength": 1
115362 },
1161666 "type": "object"
11716012 },
1181368 "name": {
1191368 "anyOf": [
12013014 {
1211301 "minLength": 1,
12213113 "type": "string"
12313014 },
1246138 {
1256138 "type": "null"
1266138 }
1271368 ],
1281368 },
12914115 "products": {
13014115 "anyOf": [
13112036 {
13212010 "items": {
1334912 "format": "uuid4",
134617 "type": "string"
13512010 },
13613026 "type": "array"
13712036 },
13821135 {
13921135 "type": "null"
14021135 }
14114115 ],
14214115 },
14313514 "starts_at": {
14413514 "anyOf": [
14512920 {
1461292 "format": "date-time",
14713118 "type": "string"
14812920 },
1496143 {
1506143 "type": "null"
1516143 }
15213514 ],
15313514 },
1541385 "type": {
1551385 "anyOf": [
15625118 {
15825118 },
15911330 {
16011330 "type": "null"
16111330 }
1621385 ]
1631385 }
16413599 },
16531812 "type": "object"
166219111}
Referenced Components (2)6 of 6 keywords
DiscountDuration3 of 3 keywords
139125{
239125 "enum": [
314n/a "once",
416n/a "forever",
59n/a "repeating"
639125 ],
740124 "type": "string"
839125}
DiscountType3 of 3 keywords
125118{
225118 "enum": [
316n/a "fixed",
49n/a "percentage"
525118 ],
626117 "type": "string"
725118}
Responses
codedescriptionhitsavg
200Discount updated.0never seen
404Discount not found.1647ms
422Validation Error2485ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1305ms
401Unauthorized12ms
email-update 2 operations 1 covered 1 partial 0 uncovered 0 not measured 93% #
Body
application/json8 / 8
EmailUpdateRequest
#validinvalidschema
112062{
212939 "properties": {
312435 "email": {
412930 "format": "email",
51545 "type": "string"
612435 },
7884 "return_to": {
8884 "anyOf": [
91379 {
101379 "type": "string"
111379 },
127517 {
137517 "type": "null"
147517 }
15884 ],
16884 }
1712939 },
1815918 "required": [
1915918 "email"
2015918 ],
211775 "type": "object"
2212062}
Responses
codedescriptionhitsavg
200Successful Response213384ms
422Validation Error1648ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized144ms
400Bad Request28ms
Query Parameters
return_to2 / 3
#validinvalidschema
135n/a{
235n/a "anyOf": [
335n/a {
435n/a "type": "string"
535n/a },
6035 {
7035 "type": "null"
8035 }
935n/a ],
1035n/a}
Body
application/x-www-form-urlencoded4 / 4
Body_email-update_verify_email_update
19917{
299n/a "properties": {
399n/a "token": {
499n/a "type": "string"
599n/a }
699n/a },
79917 "required": [
89917 "token"
99917 ],
10116n/a "type": "object"
119917}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error357ms
Undocumented - not in spec
codedescriptionhitsavg
303748ms
400Bad Request14ms
500Internal Server Error22831ms
401Unauthorized33ms
event-types 2 operations 1 covered 1 partial 0 uncovered 0 not measured 72% #
Query Parameters
organization_id2 / 7
#validinvalidschema
15390{
25390 "anyOf": [
30539 {
400 "format": "uuid4",
50n/a "type": "string",
60539 },
75390 {
85390 "items": {
95390 "format": "uuid4",
10539n/a "type": "string",
115390 },
125390 "type": "array"
135390 },
140539 {
150539 "type": "null"
160539 }
175390 ],
185390}
customer_id4 / 7
125435{
225435 "anyOf": [
30289 {
400 "format": "uuid4",
50n/a "type": "string"
60289 },
725435 {
825435 "items": {
955158 "format": "uuid4",
10609n/a "type": "string"
1125435 },
122890 "type": "array"
1325435 },
140289 {
150289 "type": "null"
160289 }
1725435 ],
1825435}
external_customer_id3 / 5
1179n/a{
2179n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
6179113 {
7179n/a "items": {
8529n/a "type": "string"
9179n/a },
102920 "type": "array"
11179113 },
120292 {
130292 "type": "null"
140292 }
15179n/a ],
16179n/a}
query3 / 3
1313n/a{
2313n/a "anyOf": [
3249n/a {
4249n/a "type": "string"
5249n/a },
664249 {
764249 "type": "null"
864249 }
9313n/a ],
10313n/a}
root_events1 / 1
132210{
232210 "type": "boolean"
332210}
parent_id4 / 4
1152155{
2152155 "anyOf": [
3143164 {
4143155 "format": "uuid",
5298n/a "type": "string"
6143164 },
79298 {
89298 "type": "null"
99298 }
10152155 ],
11152155}
source5 / 5
1122150{
2122150 "anyOf": [
3112160 {
5112160 },
610262 {
710262 "type": "null"
810262 }
9122150 ],
10122150}
Referenced Components (1)3 of 3 keywords
EventSource3 of 3 keywords
1112160{
2112160 "enum": [
381n/a "system",
431n/a "user"
5112160 ],
6262n/a "type": "string"
7112160}
page2 / 2
131126{
23113 "exclusiveMinimum": 0,
331423 "type": "integer"
431126}
limit2 / 2
133520{
23352 "exclusiveMinimum": 0,
333718 "type": "integer"
433520}
sorting4 / 6
118363{
218363 "anyOf": [
318363 {
418363 "items": {
618363 },
72460 "type": "array"
818363 },
90246 {
100246 "type": "null"
110246 }
1218363 ],
1318363}
Referenced Components (1)3 of 3 keywords
EventTypesSortProperty3 of 3 keywords
146577{
246577 "enum": [
339n/a "name",
435n/a "-name",
551n/a "label",
647n/a "-label",
736n/a "occurrences",
833n/a "-occurrences",
973n/a "first_seen",
1035n/a "-first_seen",
1144n/a "last_seen",
1272n/a "-last_seen"
1346577 ],
14479n/a "type": "string"
1546577}
Responses
codedescriptionhitsavg
200Successful Response2838ms
422Validation Error2186ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized333ms
500Internal Server Error51527ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
falseroot_events
1page
10limit
[ "-last_seen" ]sorting
Path Parameters
id2 / 2
#validinvalidschema
143324{
243324 "format": "uuid4",
3457n/a "type": "string"
443324}
Body
application/json11 / 11
EventTypeUpdate
137645{
238032 "properties": {
338424 "label": {
43981 "maxLength": 128,
538514 "minLength": 1,
63999 "type": "string"
738424 },
89916 "label_property_selector": {
99916 "anyOf": [
107441 {
11761 "maxLength": 256,
12752 "minLength": 1,
137738 "type": "string"
147441 },
152590 {
162590 "type": "null"
172590 }
189916 ],
199916 }
2038032 },
214087 "required": [
224087 "label"
234087 ],
244156 "type": "object"
2537645}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Not Found3546ms
422Validation Error835ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized102ms
400Bad Request105ms
events 5 operations 1 covered 4 partial 0 uncovered 0 not measured 70% #
Query Parameters
filter3 / 3
#validinvalidschema
1171n/a{
2171n/a "anyOf": [
3159n/a {
4159n/a "type": "string"
5159n/a },
612159 {
712159 "type": "null"
812159 }
9171n/a ],
10171n/a}
start_timestamp4 / 4
120536{
220536 "anyOf": [
320041 {
420036 "format": "date-time",
5236n/a "type": "string"
620041 },
75236 {
85236 "type": "null"
95236 }
1020536 ],
1120536}
end_timestamp4 / 4
120654{
220654 "anyOf": [
320258 {
420254 "format": "date-time",
5256n/a "type": "string"
620258 },
74256 {
84256 "type": "null"
94256 }
1020654 ],
1120654}
organization_id2 / 7
16770{
26770 "anyOf": [
30677 {
400 "format": "uuid4",
50n/a "type": "string",
60677 },
76770 {
86770 "items": {
96770 "format": "uuid4",
10677n/a "type": "string",
116770 },
126770 "type": "array"
136770 },
140677 {
150677 "type": "null"
160677 }
176770 ],
186770}
customer_id4 / 7
119730{
219730 "anyOf": [
30227 {
400 "format": "uuid4",
50n/a "type": "string"
60227 },
719730 {
819730 "items": {
947916 "format": "uuid4",
10495n/a "type": "string"
1119730 },
122270 "type": "array"
1319730 },
140227 {
150227 "type": "null"
160227 }
1719730 ],
1819730}
external_customer_id3 / 5
1121n/a{
2121n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
6121104 {
7121n/a "items": {
8318n/a "type": "string"
9121n/a },
102250 "type": "array"
11121104 },
120225 {
130225 "type": "null"
140225 }
15121n/a ],
16121n/a}
meter_id4 / 4
117214{
217214 "anyOf": [
315828 {
415814 "format": "uuid4",
5172n/a "type": "string"
615828 },
714172 {
814172 "type": "null"
914172 }
1017214 ],
1117214}
name3 / 5
1103n/a{
2103n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
610389 {
7103n/a "items": {
8144n/a "type": "string"
9103n/a },
101920 "type": "array"
1110389 },
120192 {
130192 "type": "null"
140192 }
15103n/a ],
16103n/a}
source4 / 7
111951{
211951 "anyOf": [
30170 {
50170 },
611951 {
711951 "items": {
911951 },
101700 "type": "array"
1111951 },
120170 {
130170 "type": "null"
140170 }
1511951 ],
1611951}
Referenced Components (1)3 of 3 keywords
EventSource3 of 3 keywords
1210230{
2210230 "enum": [
3150n/a "system",
460n/a "user"
5210230 ],
6223n/a "type": "string"
7210230}
query3 / 3
1172n/a{
2172n/a "anyOf": [
3154n/a {
4154n/a "type": "string"
5154n/a },
618154 {
718154 "type": "null"
818154 }
9172n/a ],
10172n/a}
parent_id4 / 4
118615{
218615 "anyOf": [
317625 {
417615 "format": "uuid4",
5191n/a "type": "string"
617625 },
710191 {
810191 "type": "null"
910191 }
1018615 ],
1118615}
hierarchical1 / 1
122110{
222110 "type": "boolean"
322110}
page2 / 2
121130{
22112 "exclusiveMinimum": 0,
321328 "type": "integer"
421130}
limit2 / 2
122516{
22252 "exclusiveMinimum": 0,
322714 "type": "integer"
422516}
sorting4 / 6
115618{
215618 "anyOf": [
315618 {
415618 "items": {
615618 },
71740 "type": "array"
815618 },
90174 {
100174 "type": "null"
110174 }
1215618 ],
1315618}
Referenced Components (1)3 of 3 keywords
EventSortProperty3 of 3 keywords
145320{
245320 "enum": [
3229n/a "timestamp",
4224n/a "-timestamp"
545320 ],
6457n/a "type": "string"
745320}
metadata4 / 13
MetadataQuery
1870{
2870 "anyOf": [
3870 {
4870 "additionalProperties": {
54540 "anyOf": [
637876 {
737876 "type": "string"
837876 },
90454 {
100454 "type": "integer"
110454 },
120454 {
130454 "type": "boolean"
140454 },
1576378 {
16760 "items": {
174090 "type": "string"
18760 },
1976378 "type": "array"
2076378 },
210454 {
22076 "items": {
230409 "type": "integer"
24076 },
2576378 "type": "array"
260454 },
270454 {
28076 "items": {
290409 "type": "boolean"
30076 },
3176378 "type": "array"
320454 }
334540 ]
34870 },
35870 "type": "object"
36870 },
37087 {
38087 "type": "null"
39087 }
40870 ],
41870}
Responses
codedescriptionhitsavg
200Successful Response35812ms
422Validation Error2817ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized273ms
500Internal Server Error111552ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
falsehierarchical
1page
10limit
[ "-timestamp" ]sorting
Body
application/json78 / 79
EventsIngest
#validinvalidschema
1421715{
2421697 "properties": {
3421697 "events": {
4421682 "items": {
5935682 "anyOf": [
64891128 {
84891128 },
94461171 {
114461171 }
12935682 ]
13421682 },
14110315 "type": "array"
15421697 }
16421697 },
1711183 "required": [
1811183 "events"
1911183 ],
20112115 "type": "object"
21421715}
Referenced Components (5)90 of 91 keywords
CostMetadata-Input12 of 12 keywords
11846216{
21870132 "properties": {
3193060 "amount": {
4193060 "anyOf": [
51722268 {
61722268 "type": "number"
71722268 },
82081782 {
920812 "pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,5}|(?=[\\d.]{1,18}0*$)\\d{0,5}\\.\\d{0,12}0*$)",
102201770 "type": "string"
112081782 }
12193060 ],
13193060 },
14191872 "currency": {
15191812 "pattern": "usd",
16193060 "type": "string"
17191872 }
181870132 },
19197824 "required": [
20199012 "amount",
21199012 "currency"
22197824 ],
23200260 "type": "object"
241846216}
EventCreateCustomer23 of 24 keywords
14891128{
2959643 "properties": {
381115 "customer_id": {
48110 "format": "uuid4",
581115 "type": "string"
681115 },
7122024 "external_id": {
8122024 "anyOf": [
91891055 {
101891055 "type": "string"
111891055 },
121031213 {
131031213 "type": "null"
141031213 }
15122024 ],
16122024 },
17755480 "metadata": {
19755480 },
20156630 "name": {
21156630 "type": "string"
22156630 },
23155434 "organization_id": {
24155434 "anyOf": [
25155038 {
2615502 "format": "uuid4",
27155236 "type": "string",
28155038 },
2941584 {
3041584 "type": "null"
3141584 }
32155434 ],
33155434 },
34122324 "parent_id": {
35122324 "anyOf": [
362031044 {
372031044 "type": "string"
382031044 },
391020227 {
401020227 "type": "null"
411020227 }
42122324 ],
43122324 },
44119636 "timestamp": {
4511966 "format": "date-time",
46120230 "type": "string"
47119636 }
48959643 },
49823779 "required": [
5015966 "name",
51826776 "customer_id"
52823779 ],
53160215 "type": "object"
544891128}
EventCreateExternalCustomer23 of 23 keywords
14461171{
2959643 "properties": {
375815 "external_customer_id": {
475815 "type": "string"
575815 },
6122024 "external_id": {
7122024 "anyOf": [
81891055 {
91891055 "type": "string"
101891055 },
111031213 {
121031213 "type": "null"
131031213 }
14122024 ],
15122024 },
16755480 "metadata": {
18755480 },
19156630 "name": {
20156630 "type": "string"
21156630 },
22155434 "organization_id": {
23155434 "anyOf": [
24155038 {
2515502 "format": "uuid4",
26155236 "type": "string",
27155038 },
2841584 {
2941584 "type": "null"
3041584 }
31155434 ],
32155434 },
33122324 "parent_id": {
34122324 "anyOf": [
352031044 {
362031044 "type": "string"
372031044 },
381020227 {
391020227 "type": "null"
401020227 }
41122324 ],
42122324 },
43119636 "timestamp": {
4411966 "format": "date-time",
45120230 "type": "string"
46119636 }
47959643 },
48770832 "required": [
4915966 "name",
50773829 "external_customer_id"
51770832 ],
52160215 "type": "object"
534461171}
EventMetadataInput13 of 13 keywords
11510960{
268860 "additionalProperties": {
3175460 "anyOf": [
46141200 {
562612 "maxLength": 500,
662612 "minLength": 1,
76381176 "type": "string"
86141200 },
93381476 {
103381476 "type": "integer"
113381476 },
124781336 {
134781336 "type": "number"
144781336 },
156621152 {
166621152 "type": "boolean"
176621152 }
18175460 ]
1968860 },
201298840 "properties": {
211846216 "_cost": {
231846216 },
241336624 "_llm": {
261336624 }
271298840 },
28241060 "type": "object"
291510960}
LLMMetadata19 of 19 keywords
11336624{
21396504 "properties": {
3152672 "cached_input_tokens": {
4152672 "type": "integer"
5152672 },
6181672 "input_tokens": {
7181672 "type": "integer"
8181672 },
9182860 "model": {
10182860 "type": "string"
11182860 },
12181672 "output_tokens": {
13181672 "type": "integer"
14181672 },
15157848 "prompt": {
16157848 "anyOf": [
171381488 {
181381488 "type": "string"
191381488 },
201440186 {
211440186 "type": "null"
221440186 }
23157848 ],
24157848 },
25150248 "response": {
26150248 "anyOf": [
271061444 {
281061444 "type": "string"
291061444 },
301396154 {
311396154 "type": "null"
321396154 }
33150248 ],
34150248 },
35181672 "total_tokens": {
36181672 "type": "integer"
37181672 },
38182860 "vendor": {
39182860 "type": "string"
40182860 }
411396504 },
42184060 "required": [
43188812 "vendor",
44188812 "model",
45188812 "input_tokens",
46188812 "output_tokens",
47188812 "total_tokens"
48184060 ],
49190060 "type": "object"
501336624}
Responses
codedescriptionhitsavg
200Successful Response9610ms
422Validation Error9846ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized713ms
500Internal Server Error61136ms
400Bad Request35ms
Examples
Body: application/json
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"EventCreateCustomer.organization_id.examples[0]
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"EventCreateExternalCustomer.organization_id.examples[0]
Query Parameters
organization_id2 / 7
#validinvalidschema
15070{
25070 "anyOf": [
30507 {
400 "format": "uuid4",
50n/a "type": "string",
60507 },
75070 {
85070 "items": {
95070 "format": "uuid4",
10507n/a "type": "string",
115070 },
125070 "type": "array"
135070 },
140507 {
150507 "type": "null"
160507 }
175070 ],
185070}
customer_id4 / 7
121536{
221536 "anyOf": [
30251 {
400 "format": "uuid4",
50n/a "type": "string"
60251 },
721536 {
821536 "items": {
963524 "format": "uuid4",
10659n/a "type": "string"
1121536 },
122510 "type": "array"
1321536 },
140251 {
150251 "type": "null"
160251 }
1721536 ],
1821536}
external_customer_id3 / 5
1176n/a{
2176n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
617679 {
7176n/a "items": {
8629n/a "type": "string"
9176n/a },
102550 "type": "array"
1117679 },
120255 {
130255 "type": "null"
140255 }
15176n/a ],
16176n/a}
source4 / 7
117756{
217756 "anyOf": [
30233 {
50233 },
617756 {
717756 "items": {
917756 },
102330 "type": "array"
1117756 },
120233 {
130233 "type": "null"
140233 }
1517756 ],
1617756}
Referenced Components (1)3 of 3 keywords
EventSource3 of 3 keywords
1389291{
2389291 "enum": [
3173n/a "system",
4216n/a "user"
5389291 ],
6398n/a "type": "string"
7389291}
query3 / 3
1262n/a{
2262n/a "anyOf": [
3234n/a {
4234n/a "type": "string"
5234n/a },
628234 {
728234 "type": "null"
828234 }
9262n/a ],
10262n/a}
page2 / 2
124736{
22472 "exclusiveMinimum": 0,
324934 "type": "integer"
424736}
limit2 / 2
126915{
22692 "exclusiveMinimum": 0,
327113 "type": "integer"
426915}
sorting4 / 6
114166{
214166 "anyOf": [
314166 {
414166 "items": {
614166 },
72070 "type": "array"
814166 },
90207 {
100207 "type": "null"
110207 }
1214166 ],
1314166}
Referenced Components (1)3 of 3 keywords
EventNamesSortProperty3 of 3 keywords
161988{
261988 "enum": [
3106n/a "name",
470n/a "-name",
550n/a "occurrences",
669n/a "-occurrences",
773n/a "first_seen",
866n/a "-first_seen",
980n/a "last_seen",
10105n/a "-last_seen"
1161988 ],
12646n/a "type": "string"
1361988}
Responses
codedescriptionhitsavg
200Successful Response3158ms
422Validation Error1476ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized373ms
500Internal Server Error81513ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-last_seen" ]sorting
Query Parameters
start_date2 / 2
#validinvalidschema
1115483{
2115483 "format": "date",
31237n/a "type": "string"
4115483}
end_date2 / 2
1115483{
2115483 "format": "date",
31237n/a "type": "string"
4115483}
timezone3 / 3
168418{
268418 "enum": [
381n/a "Africa/Abidjan",
41n/a "Africa/Accra",
51n/a "Africa/Addis_Ababa",
61n/a "Africa/Algiers",
71n/a "Africa/Asmara",
81n/a "Africa/Bamako",
91n/a "Africa/Bangui",
101n/a "Africa/Banjul",
111n/a "Africa/Bissau",
122n/a "Africa/Blantyre",
132n/a "Africa/Brazzaville",
141n/a "Africa/Bujumbura",
151n/a "Africa/Cairo",
161n/a "Africa/Casablanca",
173n/a "Africa/Ceuta",
181n/a "Africa/Conakry",
191n/a "Africa/Dakar",
201n/a "Africa/Dar_es_Salaam",
212n/a "Africa/Djibouti",
221n/a "Africa/Douala",
231n/a "Africa/El_Aaiun",
241n/a "Africa/Freetown",
252n/a "Africa/Gaborone",
262n/a "Africa/Harare",
271n/a "Africa/Johannesburg",
281n/a "Africa/Juba",
291n/a "Africa/Kampala",
301n/a "Africa/Khartoum",
311n/a "Africa/Kigali",
321n/a "Africa/Kinshasa",
331n/a "Africa/Lagos",
341n/a "Africa/Libreville",
351n/a "Africa/Lome",
362n/a "Africa/Luanda",
371n/a "Africa/Lubumbashi",
381n/a "Africa/Lusaka",
391n/a "Africa/Malabo",
401n/a "Africa/Maputo",
411n/a "Africa/Maseru",
421n/a "Africa/Mbabane",
431n/a "Africa/Mogadishu",
441n/a "Africa/Monrovia",
451n/a "Africa/Nairobi",
462n/a "Africa/Ndjamena",
472n/a "Africa/Niamey",
481n/a "Africa/Nouakchott",
491n/a "Africa/Ouagadougou",
501n/a "Africa/Porto-Novo",
512n/a "Africa/Sao_Tome",
521n/a "Africa/Timbuktu",
532n/a "Africa/Tripoli",
541n/a "Africa/Tunis",
551n/a "Africa/Windhoek",
561n/a "America/Adak",
571n/a "America/Anchorage",
582n/a "America/Anguilla",
591n/a "America/Antigua",
601n/a "America/Araguaina",
611n/a "America/Argentina/Buenos_Aires",
621n/a "America/Argentina/Catamarca",
631n/a "America/Argentina/Cordoba",
641n/a "America/Argentina/Jujuy",
651n/a "America/Argentina/La_Rioja",
661n/a "America/Argentina/Mendoza",
671n/a "America/Argentina/Rio_Gallegos",
681n/a "America/Argentina/Salta",
691n/a "America/Argentina/San_Juan",
701n/a "America/Argentina/San_Luis",
711n/a "America/Argentina/Tucuman",
721n/a "America/Argentina/Ushuaia",
731n/a "America/Aruba",
741n/a "America/Asuncion",
751n/a "America/Atikokan",
761n/a "America/Atka",
771n/a "America/Bahia",
781n/a "America/Bahia_Banderas",
791n/a "America/Barbados",
801n/a "America/Belem",
811n/a "America/Belize",
821n/a "America/Blanc-Sablon",
831n/a "America/Boa_Vista",
841n/a "America/Bogota",
851n/a "America/Boise",
861n/a "America/Cambridge_Bay",
871n/a "America/Campo_Grande",
881n/a "America/Cancun",
891n/a "America/Caracas",
901n/a "America/Cayenne",
911n/a "America/Cayman",
921n/a "America/Chicago",
936n/a "America/Chihuahua",
941n/a "America/Ciudad_Juarez",
951n/a "America/Coral_Harbour",
961n/a "America/Costa_Rica",
971n/a "America/Coyhaique",
982n/a "America/Creston",
991n/a "America/Cuiaba",
1001n/a "America/Curacao",
1011n/a "America/Danmarkshavn",
1021n/a "America/Dawson",
1031n/a "America/Dawson_Creek",
1041n/a "America/Denver",
1051n/a "America/Detroit",
1061n/a "America/Dominica",
1071n/a "America/Edmonton",
1081n/a "America/Eirunepe",
1091n/a "America/El_Salvador",
1101n/a "America/Ensenada",
1111n/a "America/Fort_Nelson",
1121n/a "America/Fortaleza",
1131n/a "America/Glace_Bay",
1141n/a "America/Goose_Bay",
1151n/a "America/Grand_Turk",
1161n/a "America/Grenada",
1171n/a "America/Guadeloupe",
1181n/a "America/Guatemala",
1191n/a "America/Guayaquil",
1202n/a "America/Guyana",
1211n/a "America/Halifax",
1221n/a "America/Havana",
1232n/a "America/Hermosillo",
1241n/a "America/Indiana/Indianapolis",
1251n/a "America/Indiana/Knox",
1261n/a "America/Indiana/Marengo",
1271n/a "America/Indiana/Petersburg",
1282n/a "America/Indiana/Tell_City",
1291n/a "America/Indiana/Vevay",
1303n/a "America/Indiana/Vincennes",
1311n/a "America/Indiana/Winamac",
1321n/a "America/Inuvik",
1331n/a "America/Iqaluit",
1341n/a "America/Jamaica",
1351n/a "America/Juneau",
1361n/a "America/Kentucky/Louisville",
1371n/a "America/Kentucky/Monticello",
1381n/a "America/Kralendijk",
1391n/a "America/La_Paz",
1401n/a "America/Lima",
1411n/a "America/Los_Angeles",
1421n/a "America/Lower_Princes",
1431n/a "America/Maceio",
1441n/a "America/Managua",
1451n/a "America/Manaus",
1461n/a "America/Marigot",
1471n/a "America/Martinique",
1481n/a "America/Matamoros",
1491n/a "America/Mazatlan",
1501n/a "America/Menominee",
1511n/a "America/Merida",
1521n/a "America/Metlakatla",
1533n/a "America/Mexico_City",
1541n/a "America/Miquelon",
1551n/a "America/Moncton",
1561n/a "America/Monterrey",
1571n/a "America/Montevideo",
1581n/a "America/Montreal",
1591n/a "America/Montserrat",
1602n/a "America/Nassau",
1611n/a "America/New_York",
1621n/a "America/Nipigon",
1631n/a "America/Nome",
1641n/a "America/Noronha",
1651n/a "America/North_Dakota/Beulah",
1661n/a "America/North_Dakota/Center",
1671n/a "America/North_Dakota/New_Salem",
1681n/a "America/Nuuk",
1691n/a "America/Ojinaga",
1703n/a "America/Panama",
1711n/a "America/Pangnirtung",
1721n/a "America/Paramaribo",
1731n/a "America/Phoenix",
1742n/a "America/Port-au-Prince",
1751n/a "America/Port_of_Spain",
1761n/a "America/Porto_Acre",
1771n/a "America/Porto_Velho",
1781n/a "America/Puerto_Rico",
1791n/a "America/Punta_Arenas",
1801n/a "America/Rainy_River",
1811n/a "America/Rankin_Inlet",
1821n/a "America/Recife",
1831n/a "America/Regina",
1842n/a "America/Resolute",
1851n/a "America/Rio_Branco",
1861n/a "America/Santa_Isabel",
1871n/a "America/Santarem",
1881n/a "America/Santiago",
1891n/a "America/Santo_Domingo",
1901n/a "America/Sao_Paulo",
1911n/a "America/Scoresbysund",
1921n/a "America/Shiprock",
1931n/a "America/Sitka",
1941n/a "America/St_Barthelemy",
1951n/a "America/St_Johns",
1961n/a "America/St_Kitts",
1971n/a "America/St_Lucia",
1981n/a "America/St_Thomas",
1991n/a "America/St_Vincent",
2001n/a "America/Swift_Current",
2011n/a "America/Tegucigalpa",
2021n/a "America/Thule",
2031n/a "America/Thunder_Bay",
2041n/a "America/Tijuana",
2051n/a "America/Toronto",
2061n/a "America/Tortola",
2071n/a "America/Vancouver",
2081n/a "America/Virgin",
2091n/a "America/Whitehorse",
2101n/a "America/Winnipeg",
2111n/a "America/Yakutat",
2121n/a "America/Yellowknife",
2131n/a "Antarctica/Casey",
2141n/a "Antarctica/Davis",
2155n/a "Antarctica/DumontDUrville",
2162n/a "Antarctica/Macquarie",
2171n/a "Antarctica/Mawson",
2182n/a "Antarctica/McMurdo",
2191n/a "Antarctica/Palmer",
2201n/a "Antarctica/Rothera",
2211n/a "Antarctica/Syowa",
2221n/a "Antarctica/Troll",
2231n/a "Antarctica/Vostok",
2241n/a "Arctic/Longyearbyen",
2251n/a "Asia/Aden",
2261n/a "Asia/Almaty",
2271n/a "Asia/Amman",
2281n/a "Asia/Anadyr",
2291n/a "Asia/Aqtau",
2301n/a "Asia/Aqtobe",
2311n/a "Asia/Ashgabat",
2321n/a "Asia/Atyrau",
2331n/a "Asia/Baghdad",
2341n/a "Asia/Bahrain",
2351n/a "Asia/Baku",
2361n/a "Asia/Bangkok",
2371n/a "Asia/Barnaul",
2381n/a "Asia/Beirut",
2391n/a "Asia/Bishkek",
2401n/a "Asia/Brunei",
2411n/a "Asia/Chita",
2421n/a "Asia/Chongqing",
2431n/a "Asia/Colombo",
2441n/a "Asia/Damascus",
2451n/a "Asia/Dhaka",
2461n/a "Asia/Dili",
2471n/a "Asia/Dubai",
2481n/a "Asia/Dushanbe",
2491n/a "Asia/Famagusta",
2501n/a "Asia/Gaza",
2511n/a "Asia/Harbin",
2521n/a "Asia/Hebron",
2531n/a "Asia/Ho_Chi_Minh",
2541n/a "Asia/Hong_Kong",
2551n/a "Asia/Hovd",
2561n/a "Asia/Irkutsk",
2571n/a "Asia/Istanbul",
2581n/a "Asia/Jakarta",
2591n/a "Asia/Jayapura",
2601n/a "Asia/Jerusalem",
2611n/a "Asia/Kabul",
2622n/a "Asia/Kamchatka",
2632n/a "Asia/Karachi",
2642n/a "Asia/Kashgar",
2651n/a "Asia/Kathmandu",
2661n/a "Asia/Khandyga",
2672n/a "Asia/Kolkata",
2681n/a "Asia/Krasnoyarsk",
2691n/a "Asia/Kuala_Lumpur",
2701n/a "Asia/Kuching",
2711n/a "Asia/Kuwait",
2721n/a "Asia/Macau",
2731n/a "Asia/Magadan",
2741n/a "Asia/Makassar",
2751n/a "Asia/Manila",
2761n/a "Asia/Muscat",
2771n/a "Asia/Nicosia",
2781n/a "Asia/Novokuznetsk",
2791n/a "Asia/Novosibirsk",
2801n/a "Asia/Omsk",
2812n/a "Asia/Oral",
2821n/a "Asia/Phnom_Penh",
2832n/a "Asia/Pontianak",
2842n/a "Asia/Pyongyang",
2852n/a "Asia/Qatar",
2861n/a "Asia/Qostanay",
2871n/a "Asia/Qyzylorda",
2882n/a "Asia/Riyadh",
2891n/a "Asia/Sakhalin",
2901n/a "Asia/Samarkand",
2911n/a "Asia/Seoul",
2921n/a "Asia/Shanghai",
2931n/a "Asia/Singapore",
2941n/a "Asia/Srednekolymsk",
2952n/a "Asia/Taipei",
2961n/a "Asia/Tashkent",
2971n/a "Asia/Tbilisi",
2981n/a "Asia/Tehran",
2991n/a "Asia/Tel_Aviv",
3001n/a "Asia/Thimphu",
3011n/a "Asia/Tokyo",
3021n/a "Asia/Tomsk",
3031n/a "Asia/Ulaanbaatar",
3041n/a "Asia/Urumqi",
3051n/a "Asia/Ust-Nera",
3061n/a "Asia/Vientiane",
3071n/a "Asia/Vladivostok",
3081n/a "Asia/Yakutsk",
3091n/a "Asia/Yangon",
3101n/a "Asia/Yekaterinburg",
3111n/a "Asia/Yerevan",
3121n/a "Atlantic/Azores",
3131n/a "Atlantic/Bermuda",
3141n/a "Atlantic/Canary",
3151n/a "Atlantic/Cape_Verde",
3162n/a "Atlantic/Faroe",
3171n/a "Atlantic/Jan_Mayen",
3181n/a "Atlantic/Madeira",
3191n/a "Atlantic/Reykjavik",
3201n/a "Atlantic/South_Georgia",
3211n/a "Atlantic/St_Helena",
3223n/a "Atlantic/Stanley",
3231n/a "Australia/Adelaide",
3241n/a "Australia/Brisbane",
3251n/a "Australia/Broken_Hill",
3261n/a "Australia/Canberra",
3271n/a "Australia/Currie",
3281n/a "Australia/Darwin",
3291n/a "Australia/Eucla",
3301n/a "Australia/Hobart",
3311n/a "Australia/Lindeman",
3321n/a "Australia/Lord_Howe",
3331n/a "Australia/Melbourne",
3341n/a "Australia/Perth",
3351n/a "Australia/Sydney",
3361n/a "Australia/Yancowinna",
3372n/a "Etc/GMT",
3381n/a "Etc/GMT+0",
3394n/a "Etc/GMT+1",
3401n/a "Etc/GMT+10",
3411n/a "Etc/GMT+11",
3421n/a "Etc/GMT+12",
3431n/a "Etc/GMT+2",
3441n/a "Etc/GMT+3",
3451n/a "Etc/GMT+4",
3461n/a "Etc/GMT+5",
3471n/a "Etc/GMT+6",
3481n/a "Etc/GMT+7",
3491n/a "Etc/GMT+8",
3501n/a "Etc/GMT+9",
3511n/a "Etc/GMT-0",
3521n/a "Etc/GMT-1",
3531n/a "Etc/GMT-10",
3541n/a "Etc/GMT-11",
3551n/a "Etc/GMT-12",
3561n/a "Etc/GMT-13",
3571n/a "Etc/GMT-14",
3581n/a "Etc/GMT-2",
3591n/a "Etc/GMT-3",
3601n/a "Etc/GMT-4",
3611n/a "Etc/GMT-5",
3621n/a "Etc/GMT-6",
3631n/a "Etc/GMT-7",
3641n/a "Etc/GMT-8",
3651n/a "Etc/GMT-9",
3662n/a "Etc/GMT0",
3671n/a "Etc/Greenwich",
3681n/a "Etc/UCT",
3691n/a "Etc/UTC",
3701n/a "Etc/Universal",
3711n/a "Etc/Zulu",
3721n/a "Europe/Amsterdam",
3733n/a "Europe/Andorra",
3741n/a "Europe/Astrakhan",
3752n/a "Europe/Athens",
3761n/a "Europe/Belfast",
3771n/a "Europe/Belgrade",
3781n/a "Europe/Berlin",
3791n/a "Europe/Bratislava",
3801n/a "Europe/Brussels",
3812n/a "Europe/Bucharest",
3821n/a "Europe/Budapest",
3831n/a "Europe/Busingen",
3841n/a "Europe/Chisinau",
3851n/a "Europe/Copenhagen",
3861n/a "Europe/Dublin",
3873n/a "Europe/Gibraltar",
3881n/a "Europe/Guernsey",
3891n/a "Europe/Helsinki",
3901n/a "Europe/Isle_of_Man",
3911n/a "Europe/Istanbul",
3921n/a "Europe/Jersey",
3931n/a "Europe/Kaliningrad",
3941n/a "Europe/Kirov",
3951n/a "Europe/Kyiv",
3961n/a "Europe/Lisbon",
3971n/a "Europe/Ljubljana",
3981n/a "Europe/London",
3991n/a "Europe/Luxembourg",
4001n/a "Europe/Madrid",
4011n/a "Europe/Malta",
4021n/a "Europe/Mariehamn",
4031n/a "Europe/Minsk",
4041n/a "Europe/Monaco",
4051n/a "Europe/Moscow",
4061n/a "Europe/Nicosia",
4071n/a "Europe/Oslo",
4081n/a "Europe/Paris",
4095n/a "Europe/Podgorica",
4101n/a "Europe/Prague",
4111n/a "Europe/Riga",
4121n/a "Europe/Rome",
4131n/a "Europe/Samara",
4141n/a "Europe/San_Marino",
4152n/a "Europe/Sarajevo",
4161n/a "Europe/Saratov",
4171n/a "Europe/Simferopol",
4181n/a "Europe/Skopje",
4191n/a "Europe/Sofia",
4201n/a "Europe/Stockholm",
4211n/a "Europe/Tallinn",
4221n/a "Europe/Tirane",
4231n/a "Europe/Tiraspol",
4243n/a "Europe/Ulyanovsk",
4251n/a "Europe/Vaduz",
4261n/a "Europe/Vatican",
4271n/a "Europe/Vienna",
4281n/a "Europe/Vilnius",
4291n/a "Europe/Volgograd",
4302n/a "Europe/Warsaw",
4311n/a "Europe/Zagreb",
4321n/a "Europe/Zurich",
4331n/a "Factory",
43417n/a "GMT",
4351n/a "Indian/Antananarivo",
4362n/a "Indian/Chagos",
4371n/a "Indian/Christmas",
4381n/a "Indian/Cocos",
4391n/a "Indian/Comoro",
4401n/a "Indian/Kerguelen",
4411n/a "Indian/Mahe",
4421n/a "Indian/Maldives",
4431n/a "Indian/Mauritius",
4443n/a "Indian/Mayotte",
4451n/a "Indian/Reunion",
4461n/a "Pacific/Apia",
4471n/a "Pacific/Auckland",
4481n/a "Pacific/Bougainville",
4491n/a "Pacific/Chatham",
4501n/a "Pacific/Chuuk",
4511n/a "Pacific/Easter",
4521n/a "Pacific/Efate",
4531n/a "Pacific/Fakaofo",
4541n/a "Pacific/Fiji",
4551n/a "Pacific/Funafuti",
4561n/a "Pacific/Galapagos",
4571n/a "Pacific/Gambier",
4581n/a "Pacific/Guadalcanal",
4591n/a "Pacific/Guam",
4601n/a "Pacific/Honolulu",
4611n/a "Pacific/Johnston",
4623n/a "Pacific/Kanton",
4631n/a "Pacific/Kiritimati",
4641n/a "Pacific/Kosrae",
4651n/a "Pacific/Kwajalein",
4661n/a "Pacific/Majuro",
4671n/a "Pacific/Marquesas",
4681n/a "Pacific/Midway",
4691n/a "Pacific/Nauru",
4701n/a "Pacific/Niue",
4712n/a "Pacific/Norfolk",
4721n/a "Pacific/Noumea",
4732n/a "Pacific/Pago_Pago",
4741n/a "Pacific/Palau",
4751n/a "Pacific/Pitcairn",
4761n/a "Pacific/Pohnpei",
4771n/a "Pacific/Port_Moresby",
4782n/a "Pacific/Rarotonga",
4791n/a "Pacific/Saipan",
4801n/a "Pacific/Samoa",
4811n/a "Pacific/Tahiti",
4821n/a "Pacific/Tarawa",
4831n/a "Pacific/Tongatapu",
4841n/a "Pacific/Wake",
4851n/a "Pacific/Wallis",
4862n/a "Pacific/Yap",
48725n/a "UTC",
4881n/a "localtime"
48968418 ],
4906984 "minLength": 1,
491702n/a "type": "string"
49268418}
interval2 / 2
TimeInterval
1115080{
2115080 "enum": [
3707n/a "year",
452n/a "month",
543n/a "week",
6285n/a "day",
763n/a "hour"
8115080 ],
91230n/a "type": "string"
10115080}
filter3 / 3
1672n/a{
2672n/a "anyOf": [
3641n/a {
4641n/a "type": "string"
5641n/a },
631641 {
731641 "type": "null"
831641 }
9672n/a ],
10672n/a}
organization_id2 / 7
112400{
212400 "anyOf": [
301240 {
400 "format": "uuid4",
50n/a "type": "string",
601240 },
712400 {
812400 "items": {
912400 "format": "uuid4",
101240n/a "type": "string",
1112400 },
1212400 "type": "array"
1312400 },
1401240 {
1501240 "type": "null"
1601240 }
1712400 ],
1812400}
customer_id4 / 7
167112{
267112 "anyOf": [
30683 {
400 "format": "uuid4",
50n/a "type": "string"
60683 },
767112 {
867112 "items": {
987824 "format": "uuid4",
10902n/a "type": "string"
1167112 },
126830 "type": "array"
1367112 },
140683 {
150683 "type": "null"
160683 }
1767112 ],
1867112}
external_customer_id3 / 5
189n/a{
289n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
689609 {
789n/a "items": {
8138n/a "type": "string"
989n/a },
106980 "type": "array"
1189609 },
120698 {
130698 "type": "null"
140698 }
1589n/a ],
1689n/a}
meter_id4 / 4
16503{
26503 "anyOf": [
36476 {
46473 "format": "uuid4",
5650n/a "type": "string"
66476 },
73650 {
83650 "type": "null"
93650 }
106503 ],
116503}
name3 / 5
174n/a{
274n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
674603 {
774n/a "items": {
8196n/a "type": "string"
974n/a },
106770 "type": "array"
1174603 },
120677 {
130677 "type": "null"
140677 }
1574n/a ],
1674n/a}
source4 / 7
161826{
261826 "anyOf": [
30644 {
50644 },
661826 {
761826 "items": {
961826 },
106440 "type": "array"
1161826 },
120644 {
130644 "type": "null"
140644 }
1561826 ],
1661826}
Referenced Components (1)3 of 3 keywords
EventSource3 of 3 keywords
1706682{
2706682 "enum": [
3620n/a "system",
486n/a "user"
5706682 ],
6726n/a "type": "string"
7706682}
event_type_id4 / 4
16617{
26617 "anyOf": [
365414 {
46547 "format": "uuid4",
5661n/a "type": "string"
665414 },
77661 {
87661 "type": "null"
97661 }
106617 ],
116617}
query3 / 3
1664n/a{
2664n/a "anyOf": [
3637n/a {
4637n/a "type": "string"
5637n/a },
627637 {
727637 "type": "null"
827637 }
9664n/a ],
10664n/a}
aggregate_fields2 / 2
1693n/a{
2693n/a "items": {
31111n/a "type": "string"
4693n/a },
5693n/a "type": "array"
6693n/a}
sorting4 / 6
162414{
262414 "anyOf": [
362414 {
462414 "items": {
662414 },
76380 "type": "array"
862414 },
90638 {
100638 "type": "null"
110638 }
1262414 ],
1362414}
Referenced Components (1)3 of 3 keywords
EventStatisticsSortProperty3 of 3 keywords
180716{
280716 "enum": [
322n/a "name",
419n/a "-name",
517n/a "occurrences",
619n/a "-occurrences",
712n/a "total",
8593n/a "-total",
920n/a "average",
1026n/a "-average",
1130n/a "p95",
1215n/a "-p95",
1316n/a "p99",
1418n/a "-p99"
1580716 ],
16809n/a "type": "string"
1780716}
metadata4 / 13
MetadataQuery
1570{
2570 "anyOf": [
3570 {
4570 "additionalProperties": {
52180 "anyOf": [
617345 {
717345 "type": "string"
817345 },
90218 {
100218 "type": "integer"
110218 },
120218 {
130218 "type": "boolean"
140218 },
1545173 {
16450 "items": {
172570 "type": "string"
18450 },
1945173 "type": "array"
2045173 },
210218 {
22045 "items": {
230257 "type": "integer"
24045 },
2545173 "type": "array"
260218 },
270218 {
28045 "items": {
290257 "type": "boolean"
30045 },
3145173 "type": "array"
320218 }
332180 ]
34570 },
35570 "type": "object"
36570 },
37057 {
38057 "type": "null"
39057 }
40570 ],
41570}
Responses
codedescriptionhitsavg
200Successful Response23516ms
422Validation Error9376ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized443ms
500Internal Server Error241631ms
Examples
Query
"UTC"timezone
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
[ "_cost.amount" ]aggregate_fields
[ "-total" ]sorting
Path Parameters
id2 / 2
#validinvalidschema
133374{
233374 "format": "uuid4",
3407n/a "type": "string"
433374}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Event not found.3037ms
422Validation Error746ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized302ms
files 5 operations 3 covered 2 partial 0 uncovered 0 not measured 89% #
Query Parameters
organization_id2 / 7
#validinvalidschema
15210{
25210 "anyOf": [
30521 {
400 "format": "uuid4",
50n/a "type": "string",
60521 },
75210 {
85210 "items": {
95210 "format": "uuid4",
10521n/a "type": "string",
115210 },
125210 "type": "array"
135210 },
140521 {
150521 "type": "null"
160521 }
175210 ],
185210}
ids4 / 7
1117198{
2117198 "anyOf": [
30315 {
400 "format": "uuid4",
50n/a "type": "string"
60315 },
7117198 {
8117198 "items": {
92691219 "format": "uuid4",
101488n/a "type": "string"
11117198 },
123150 "type": "array"
13117198 },
140315 {
150315 "type": "null"
160315 }
17117198 ],
18117198}
page2 / 2
127832{
22789 "exclusiveMinimum": 0,
328723 "type": "integer"
427832}
limit2 / 2
1133213{
213333 "exclusiveMinimum": 0,
3166180 "type": "integer"
4133213}
Responses
codedescriptionhitsavg
200Successful Response2387ms
422Validation Error2306ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized502ms
500Internal Server Error31419ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
Body
application/json76 / 79
FileCreate
#validinvalidschema
1210498{
2210498 "oneOf": [
390618 {
590618 },
661647 {
861647 },
959649 {
1159649 }
12210498 ]
13210498}
Referenced Components (5)92 of 95 keywords
DownloadableFileCreate23 of 24 keywords
190618{
2102596 "properties": {
357124 "checksum_sha256_base64": {
457124 "anyOf": [
532563 {
632563 "type": "string"
732563 },
853956 {
953956 "type": "null"
1053956 }
1157124 ],
1257124 },
1364830 "mime_type": {
1464830 "type": "string"
1564830 },
1664831 "name": {
1764831 "type": "string"
1864831 },
1964424 "organization_id": {
2064424 "anyOf": [
2163830 {
226380 "format": "uuid4",
2363830 "type": "string",
2463830 },
256662 {
266662 "type": "null"
276662 }
2864424 ],
2964424 },
30236456 "service": {
31236456 "const": "downloadable",
3266230 "type": "string"
33236456 },
3464236 "size": {
3564236 "type": "integer"
3664236 },
37432246 "upload": {
39432246 },
4056225 "version": {
4156225 "anyOf": [
4230557 {
4330557 "type": "string"
4430557 },
4553255 {
4653255 "type": "null"
4753255 }
4856225 ],
4956225 }
50102596 },
5165642 "required": [
5267919 "name",
5367820 "mime_type",
5467820 "size",
5567820 "upload",
566926 "service"
5765642 ],
5869810 "type": "object"
5990618}
OrganizationAvatarFileCreate25 of 26 keywords
159649{
269629 "properties": {
357124 "checksum_sha256_base64": {
457124 "anyOf": [
532563 {
632563 "type": "string"
732563 },
853956 {
953956 "type": "null"
1053956 }
1157124 ],
1257124 },
13406272 "mime_type": {
14406242 "pattern": "^image\\/(jpeg|png|gif|webp|svg\\+xml)$",
1564830 "type": "string"
16406272 },
1764831 "name": {
1864831 "type": "string"
1964831 },
2064424 "organization_id": {
2164424 "anyOf": [
2263830 {
236380 "format": "uuid4",
2463830 "type": "string",
2563830 },
266662 {
276662 "type": "null"
286662 }
2964424 ],
3064424 },
31209483 "service": {
32209483 "const": "organization_avatar",
3366230 "type": "string"
34209483 },
3563048 "size": {
3663612 "maximum": 1048576.0,
3764236 "type": "integer"
3863048 },
39432246 "upload": {
41432246 },
4256225 "version": {
4356225 "anyOf": [
4430557 {
4530557 "type": "string"
4630557 },
4753255 {
4853255 "type": "null"
4953255 }
5056225 ],
5156225 }
5269629 },
5365642 "required": [
5467919 "name",
5567820 "mime_type",
5667820 "size",
5767820 "upload",
586926 "service"
5965642 ],
6069810 "type": "object"
6159649}
ProductMediaFileCreate25 of 26 keywords
161647{
271627 "properties": {
357124 "checksum_sha256_base64": {
457124 "anyOf": [
532563 {
632563 "type": "string"
732563 },
853956 {
953956 "type": "null"
1053956 }
1157124 ],
1257124 },
13406272 "mime_type": {
14406242 "pattern": "^image\\/(jpeg|png|gif|webp|svg\\+xml)$",
1564830 "type": "string"
16406272 },
1764831 "name": {
1864831 "type": "string"
1964831 },
2064424 "organization_id": {
2164424 "anyOf": [
2263830 {
236380 "format": "uuid4",
2463830 "type": "string",
2563830 },
266662 {
276662 "type": "null"
286662 }
2964424 ],
3064424 },
31211481 "service": {
32211481 "const": "product_media",
3366230 "type": "string"
34211481 },
3563840 "size": {
366444 "maximum": 10485760.0,
3764236 "type": "integer"
3863840 },
39432246 "upload": {
41432246 },
4256225 "version": {
4356225 "anyOf": [
4430557 {
4530557 "type": "string"
4630557 },
4753255 {
4853255 "type": "null"
4953255 }
5056225 ],
5156225 }
5271627 },
5365642 "required": [
5467919 "name",
5567820 "mime_type",
5667820 "size",
5767820 "upload",
586926 "service"
5965642 ],
6069810 "type": "object"
6161647}
S3FileCreateMultipart7 of 7 keywords
11296738{
21296630 "properties": {
31296630 "parts": {
41296540 "items": {
61296540 },
7183690 "type": "array"
81296630 }
91296630 },
10192618 "required": [
11192618 "parts"
12192618 ],
13194490 "type": "object"
141296738}
S3FileCreatePart12 of 12 keywords
11455540{
21509396 "properties": {
3114372 "checksum_sha256_base64": {
4114372 "anyOf": [
5348867 {
6348867 "type": "string"
7348867 },
8795420 {
9795420 "type": "null"
10795420 }
11114372 ],
12114372 },
131779108 "chunk_end": {
141779108 "type": "integer"
151779108 },
161779108 "chunk_start": {
171779108 "type": "integer"
181779108 },
191779108 "number": {
201779108 "type": "integer"
211779108 }
221509396 },
23185154 "required": [
24188718 "number",
25188718 "chunk_start",
26188718 "chunk_end"
27185154 ],
28190590 "type": "object"
291455540}
Responses
codedescriptionhitsavg
201File created.0never seen
422Validation Error6095ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error1161055ms
401Unauthorized53ms
400Bad Request16ms
Examples
Body: application/json
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"DownloadableFileCreate.organization_id.examples[0]
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"ProductMediaFileCreate.organization_id.examples[0]
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"OrganizationAvatarFileCreate.organization_id.examples[0]
Path Parameters
id2 / 2
#validinvalidschema
133766{
233766 "format": "uuid4",
3403n/a "type": "string"
433766}
Responses
codedescriptionhitsavg
204File deleted.0never seen
403You don't have the permission to delete this file.0never seen
404File not found.3016ms
422Validation Error665ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized362ms
Path Parameters
id2 / 2
#validinvalidschema
140815{
240815 "format": "uuid4",
3423n/a "type": "string"
440815}
Body
application/json8 / 8
FilePatch
136633{
29025 "properties": {
38415 "name": {
48415 "anyOf": [
56732 {
66732 "type": "string"
76732 },
81782 {
91782 "type": "null"
101782 }
118415 ],
128415 },
136116 "version": {
146116 "anyOf": [
152750 {
162750 "type": "string"
172750 },
183443 {
193443 "type": "null"
203443 }
216116 ],
226116 }
239025 },
243918 "type": "object"
2536633}
Responses
codedescriptionhitsavg
200File updated.0never seen
403You don't have the permission to update this file.0never seen
404File not found.3537ms
422Validation Error545ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request105ms
401Unauthorized62ms
Path Parameters
id2 / 2
#validinvalidschema
142631{
242631 "format": "uuid4",
3457n/a "type": "string"
442631}
Body
application/json15 / 15
FileUploadCompleted
121867{
223049 "properties": {
325910 "id": {
425910 "type": "string"
525910 },
623939 "parts": {
723933 "items": {
923933 },
102726 "type": "array"
1123939 },
122708 "path": {
132708 "type": "string"
142708 }
1523049 },
1626713 "required": [
1726911 "id",
182782 "path",
192782 "parts"
2026713 ],
212805 "type": "object"
2221867}
Referenced Components (1)11 of 11 keywords
S3FileUploadCompletedPart11 of 11 keywords
1616100{
262328 "properties": {
363017 "checksum_etag": {
463017 "type": "string"
563017 },
663713 "checksum_sha256_base64": {
763713 "anyOf": [
8265385 {
9265385 "type": "string"
10265385 },
11372278 {
12372278 "type": "null"
13372278 }
1463713 ],
1563713 },
166436 "number": {
176436 "type": "integer"
186436 }
1962328 },
206447 "required": [
216492 "number",
226474 "checksum_etag",
236501 "checksum_sha256_base64"
246447 ],
2565165 "type": "object"
26616100}
Responses
codedescriptionhitsavg
200File upload completed.0never seen
403You don't have the permission to update this file.0never seen
404File not found.1967ms
422Validation Error1635ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request915ms
401Unauthorized72ms
integrations_apple 2 operations 0 covered 2 partial 0 uncovered 0 not measured 85% #
Query Parameters
return_to2 / 3
#validinvalidschema
112n/a{
212n/a "anyOf": [
312n/a {
412n/a "type": "string"
512n/a },
6012 {
7012 "type": "null"
8012 }
912n/a ],
1012n/a}
attribution2 / 3
17n/a{
27n/a "anyOf": [
37n/a {
47n/a "type": "string"
57n/a },
607 {
707 "type": "null"
807 }
97n/a ],
107n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
30343451ms
500Internal Server Error2726ms
Body
application/x-www-form-urlencoded13 / 14
Body_integrations_apple_integrations.apple.callback
#validinvalidschema
11670{
21500 "properties": {
3106n/a "code": {
4106n/a "anyOf": [
575n/a {
675n/a "type": "string"
775n/a },
83175 {
93175 "type": "null"
103175 }
11106n/a ],
12106n/a },
13113n/a "code_verifier": {
14113n/a "anyOf": [
1580n/a {
1680n/a "type": "string"
1780n/a },
183380 {
193380 "type": "null"
203380 }
21113n/a ],
22113n/a },
23113n/a "error": {
24113n/a "anyOf": [
2572n/a {
2672n/a "type": "string"
2772n/a },
284172 {
294172 "type": "null"
304172 }
31113n/a ],
32113n/a },
3373n/a "state": {
3473n/a "anyOf": [
3533n/a {
3633n/a "type": "string"
3733n/a },
384033 {
394033 "type": "null"
404033 }
4173n/a ],
4273n/a }
431500 },
44167n/a "type": "object"
451670}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2326ms
500Internal Server Error20865ms
integrations_discord 3 operations 2 covered 1 partial 0 uncovered 0 not measured 92% #
Query Parameters
return_to2 / 3
#validinvalidschema
1282n/a{
2282n/a "anyOf": [
3282n/a {
4282n/a "type": "string"
5282n/a },
60282 {
70282 "type": "null"
80282 }
9282n/a ],
10282n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
3033785ms
401Unauthorized632ms
Query Parameters
state1 / 1
#validinvalidschema
1441n/a{
2441n/a "type": "string"
3441n/a}
code3 / 3
1219n/a{
2219n/a "anyOf": [
3145n/a {
4145n/a "type": "string"
5145n/a },
674145 {
774145 "type": "null"
874145 }
9219n/a ],
10219n/a}
code_verifier3 / 3
1275n/a{
2275n/a "anyOf": [
3257n/a {
4257n/a "type": "string"
5257n/a },
618257 {
718257 "type": "null"
818257 }
9275n/a ],
10275n/a}
error3 / 3
1142n/a{
2142n/a "anyOf": [
3127n/a {
4127n/a "type": "string"
5127n/a },
615127 {
715127 "type": "null"
815127 }
9142n/a ],
10142n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error55ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4415ms
Query Parameters
guild_token1 / 1
#validinvalidschema
1424n/a{
2424n/a "type": "string"
3424n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error16ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4243ms
integrations_github 2 operations 0 covered 2 partial 0 uncovered 0 not measured 85% #
Query Parameters
payment_intent_id3 / 3
#validinvalidschema
131n/a{
231n/a "anyOf": [
327n/a {
427n/a "type": "string"
527n/a },
6427 {
7427 "type": "null"
8427 }
931n/a ],
1031n/a}
return_to2 / 3
133n/a{
233n/a "anyOf": [
333n/a {
433n/a "type": "string"
533n/a },
6033 {
7033 "type": "null"
8033 }
933n/a ],
1033n/a}
attribution2 / 3
139n/a{
239n/a "anyOf": [
339n/a {
439n/a "type": "string"
539n/a },
6039 {
7039 "type": "null"
8039 }
939n/a ],
1039n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
3031794ms
500Internal Server Error23825ms
Query Parameters
code3 / 3
#validinvalidschema
151n/a{
251n/a "anyOf": [
348n/a {
448n/a "type": "string"
548n/a },
6348 {
7348 "type": "null"
8348 }
951n/a ],
1051n/a}
code_verifier3 / 3
1110n/a{
2110n/a "anyOf": [
3108n/a {
4108n/a "type": "string"
5108n/a },
62108 {
72108 "type": "null"
82108 }
9110n/a ],
10110n/a}
state2 / 3
189n/a{
289n/a "anyOf": [
389n/a {
489n/a "type": "string"
589n/a },
6089 {
7089 "type": "null"
8089 }
989n/a ],
1089n/a}
error3 / 3
1114n/a{
2114n/a "anyOf": [
3102n/a {
4102n/a "type": "string"
5102n/a },
612102 {
712102 "type": "null"
812102 }
9114n/a ],
10114n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error32202ms
400Bad Request3085ms
integrations_github_repository_benefit 5 operations 3 covered 2 partial 0 uncovered 0 not measured 86% #
Responses
codedescriptionhitsavg
200Successful Response345ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4302ms
Responses
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
303365ms
401Unauthorized4242ms
Query Parameters
return_to2 / 3
#validinvalidschema
1265n/a{
2265n/a "anyOf": [
3265n/a {
4265n/a "type": "string"
5265n/a },
60265 {
70265 "type": "null"
80265 }
9265n/a ],
10265n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
3033525ms
401Unauthorized812ms
Query Parameters
code3 / 3
#validinvalidschema
145n/a{
245n/a "anyOf": [
341n/a {
441n/a "type": "string"
541n/a },
6441 {
7441 "type": "null"
8441 }
945n/a ],
1045n/a}
code_verifier2 / 3
1237n/a{
2237n/a "anyOf": [
3237n/a {
4237n/a "type": "string"
5237n/a },
60237 {
70237 "type": "null"
80237 }
9237n/a ],
10237n/a}
state3 / 3
148n/a{
248n/a "anyOf": [
344n/a {
444n/a "type": "string"
544n/a },
6444 {
7444 "type": "null"
8444 }
948n/a ],
1048n/a}
error3 / 3
159n/a{
259n/a "anyOf": [
353n/a {
453n/a "type": "string"
553n/a },
6653 {
7653 "type": "null"
8653 }
959n/a ],
1059n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error16190ms
400Bad Request3736ms
401Unauthorized362ms
Responses
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error3410ms
401Unauthorized4272ms
integrations_google 2 operations 1 covered 1 partial 0 uncovered 0 not measured 94% #
Query Parameters
return_to2 / 3
#validinvalidschema
125n/a{
225n/a "anyOf": [
325n/a {
425n/a "type": "string"
525n/a },
6025 {
7025 "type": "null"
8025 }
925n/a ],
1025n/a}
attribution3 / 3
132n/a{
232n/a "anyOf": [
330n/a {
430n/a "type": "string"
530n/a },
6230 {
7230 "type": "null"
8230 }
932n/a ],
1032n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
3031045ms
500Internal Server Error25794ms
Query Parameters
code3 / 3
#validinvalidschema
1182n/a{
2182n/a "anyOf": [
3151n/a {
4151n/a "type": "string"
5151n/a },
631151 {
731151 "type": "null"
831151 }
9182n/a ],
10182n/a}
code_verifier3 / 3
1183n/a{
2183n/a "anyOf": [
3146n/a {
4146n/a "type": "string"
5146n/a },
637146 {
737146 "type": "null"
837146 }
9183n/a ],
10183n/a}
state3 / 3
1129n/a{
2129n/a "anyOf": [
3104n/a {
4104n/a "type": "string"
5104n/a },
625104 {
725104 "type": "null"
825104 }
9129n/a ],
10129n/a}
error3 / 3
1202n/a{
2202n/a "anyOf": [
3153n/a {
4153n/a "type": "string"
5153n/a },
649153 {
749153 "type": "null"
849153 }
9202n/a ],
10202n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error7177ms
400Bad Request3175ms
license_keys 7 operations 3 covered 4 partial 0 uncovered 0 not measured 80% #
Query Parameters
organization_id2 / 7
#validinvalidschema
16460{
26460 "anyOf": [
30646 {
400 "format": "uuid4",
50n/a "type": "string",
60646 },
76460 {
86460 "items": {
96460 "format": "uuid4",
10646n/a "type": "string",
116460 },
126460 "type": "array"
136460 },
140646 {
150646 "type": "null"
160646 }
176460 ],
186460}
benefit_id2 / 7
15700{
25700 "anyOf": [
30570 {
400 "format": "uuid4",
50n/a "type": "string",
60570 },
75700 {
85700 "items": {
95770 "format": "uuid4",
10577n/a "type": "string",
115700 },
125700 "type": "array"
135700 },
140570 {
150570 "type": "null"
160570 }
175700 ],
185700}
page2 / 2
119929{
21992 "exclusiveMinimum": 0,
320127 "type": "integer"
419929}
limit2 / 2
131224{
23124 "exclusiveMinimum": 0,
331620 "type": "integer"
431224}
Responses
codedescriptionhitsavg
200Successful Response3957ms
401Not authorized to manage license key.2223ms
404License key not found.0never seen
422Validation Error285ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error11389ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
Body
application/json25 / 29
LicenseKeyActivate
#validinvalidschema
135447{
236333 "properties": {
314211 "conditions": {
4763 "additionalProperties": {
52064 "anyOf": [
678132 {
7801 "maxLength": 500,
8792 "minLength": 1,
981129 "type": "string"
1078132 },
1131179 {
1231179 "type": "integer"
1331179 },
1451159 {
1551159 "type": "number"
1651159 },
1777133 {
1877133 "type": "boolean"
1977133 }
202064 ]
21763 },
221450 "maxProperties": 50,
23772 "propertyNames": {
242091 "maxLength": 40,
252091 "minLength": 1
26772 },
271458 "type": "object"
2814211 },
293845 "key": {
303845 "type": "string"
313845 },
323875 "label": {
333875 "type": "string"
343875 },
3516111 "meta": {
36975 "additionalProperties": {
3725911 "anyOf": [
3891179 {
39930 "maxLength": 500,
40912 "minLength": 1,
4193177 "type": "string"
4291179 },
4348222 {
4448222 "type": "integer"
4548222 },
4673197 {
4773197 "type": "number"
4873197 },
4995175 {
5095175 "type": "boolean"
5195175 }
5225911 ]
53975 },
541660 "maxProperties": 50,
551002 "propertyNames": {
562691 "maxLength": 40,
572691 "minLength": 1
581002 },
591666 "type": "object"
6016111 },
613905 "organization_id": {
623900 "format": "uuid4",
633905 "type": "string"
643905 }
6536333 },
663879 "required": [
673897 "key",
683951 "organization_id",
693924 "label"
703879 ],
713965 "type": "object"
7235447}
Responses
codedescriptionhitsavg
200Successful Response0never seen
403License key activation not supported or limit reached. Use /validate endpoint for licenses without activations.0never seen
404License key not found.2957ms
422Validation Error1295ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized563ms
400Bad Request926ms
500Internal Server Error31388ms
Body
application/json7 / 8
LicenseKeyDeactivate
#validinvalidschema
115750{
217527 "properties": {
31849 "activation_id": {
41844 "format": "uuid4",
51885 "type": "string"
61849 },
717413 "key": {
817413 "type": "string"
917413 },
101965 "organization_id": {
111960 "format": "uuid4",
121965 "type": "string"
131965 }
1417527 },
1518418 "required": [
1618715 "key",
172011 "organization_id",
181939 "activation_id"
1918418 ],
202025 "type": "object"
2115750}
Responses
codedescriptionhitsavg
204License key activation deactivated.0never seen
404License key not found.1267ms
422Validation Error1565ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1195ms
401Unauthorized312ms
Body
application/json26 / 32
LicenseKeyValidate
#validinvalidschema
120558{
221543 "properties": {
31347 "activation_id": {
41347 "anyOf": [
57665 {
6760 "format": "uuid4",
77665 "type": "string"
87665 },
95883 {
105883 "type": "null"
115883 }
121347 ],
131347 },
142197 "benefit_id": {
152197 "anyOf": [
1621016 {
172100 "format": "uuid4",
1821016 "type": "string",
1921016 },
209217 {
219217 "type": "null"
229217 }
232197 ],
242197 },
2511910 "conditions": {
26593 "additionalProperties": {
271683 "anyOf": [
2862109 {
29650 "maxLength": 500,
30623 "minLength": 1,
3165106 "type": "string"
3262109 },
3328143 {
3428143 "type": "integer"
3528143 },
3640131 {
3740131 "type": "number"
3840131 },
3966105 {
4066105 "type": "boolean"
4166105 }
421683 ]
43593 },
441240 "maxProperties": 50,
45584 "propertyNames": {
461683 "maxLength": 40,
471701 "minLength": 1
48584 },
491245 "type": "object"
5011910 },
511244 "customer_id": {
521244 "anyOf": [
537850 {
54780 "format": "uuid4",
557850 "type": "string"
567850 },
574682 {
584682 "type": "null"
594682 }
601244 ],
611244 },
621265 "increment_usage": {
631265 "anyOf": [
644586 {
654586 "type": "integer"
664586 },
678150 {
688150 "type": "null"
698150 }
701265 ],
711265 },
722445 "key": {
732445 "type": "string"
742445 },
752525 "organization_id": {
762520 "format": "uuid4",
772525 "type": "string"
782525 }
7921543 },
8024810 "required": [
812499 "key",
822571 "organization_id"
8324810 ],
842585 "type": "object"
8520558}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404License key not found.1557ms
422Validation Error1507ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized513ms
400Bad Request1155ms
Path Parameters
id2 / 2
#validinvalidschema
136840{
236840 "format": "uuid4",
3408n/a "type": "string"
436840}
Responses
codedescriptionhitsavg
200Successful Response0never seen
401Not authorized to manage license key.352ms
404License key not found.3337ms
422Validation Error405ms
Path Parameters
id2 / 2
#validinvalidschema
143230{
243230 "format": "uuid4",
3462n/a "type": "string"
443230}
Body
application/json21 / 21
LicenseKeyUpdate
133353{
213144 "properties": {
312810 "expires_at": {
412810 "anyOf": [
510830 {
61082 "format": "date-time",
711028 "type": "string"
810830 },
920118 {
1020118 "type": "null"
1120118 }
1212810 ],
1312810 },
149120 "limit_activations": {
159120 "anyOf": [
167338 {
17761 "exclusiveMinimum": 0.0,
18752 "maximum": 1000.0,
197635 "type": "integer"
207338 },
211893 {
221893 "type": "null"
231893 }
249120 ],
259120 },
2610211 "limit_usage": {
2710211 "anyOf": [
287439 {
29753 "exclusiveMinimum": 0.0,
307736 "type": "integer"
317439 },
322885 {
332885 "type": "null"
342885 }
3510211 ],
3610211 },
378410 "status": {
388410 "anyOf": [
392173 {
412173 },
426331 {
436331 "type": "null"
446331 }
458410 ]
468410 },
471096 "usage": {
481096 "type": "integer"
491096 }
5013144 },
513779 "type": "object"
5233353}
Referenced Components (1)3 of 3 keywords
LicenseKeyStatus3 of 3 keywords
12173{
22173 "enum": [
37n/a "granted",
41n/a "revoked",
513n/a "disabled"
62173 ],
72371 "type": "string"
82173}
Responses
codedescriptionhitsavg
200Successful Response0never seen
401Not authorized to manage license key.182ms
404License key not found.2938ms
422Validation Error1205ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request316ms
Examples
Body: application/json
0LicenseKeyUpdate.usage
Path Parameters
id2 / 2
#validinvalidschema
133965{
233965 "format": "uuid4",
3404n/a "type": "string"
433965}
activation_id2 / 2
134064{
234064 "format": "uuid4",
3404n/a "type": "string"
434064}
Responses
codedescriptionhitsavg
200Successful Response0never seen
401Not authorized to manage license key.182ms
404License key not found.3147ms
422Validation Error725ms
login_code 2 operations 1 covered 1 partial 0 uncovered 0 not measured 93% #
Query Parameters
email2 / 2
#validinvalidschema
135571{
235571 "format": "email",
3426n/a "type": "string"
435571}
return_to3 / 3
1121n/a{
2121n/a "anyOf": [
3114n/a {
4114n/a "type": "string"
5114n/a },
67114 {
77114 "type": "null"
87114 }
9121n/a ],
10121n/a}
Body
application/x-www-form-urlencoded4 / 4
Body_login_code_authenticate_login_code
1247129{
2247n/a "properties": {
3247n/a "code": {
4247n/a "type": "string"
5247n/a }
6247n/a },
7247129 "required": [
8247129 "code"
9247129 ],
10376n/a "type": "object"
11247129}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error4208ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request14ms
3031114ms
500Internal Server Error1764ms
Body
application/json47 / 51
LoginCodeRequest
#validinvalidschema
14881{
24975 "properties": {
35459 "attribution": {
45459 "anyOf": [
53776 {
73776 },
81796 {
91796 "type": "null"
101796 }
115459 ]
125459 },
1311112 "email": {
141167 "format": "email",
151185 "type": "string"
1611112 },
171074 "return_to": {
181074 "anyOf": [
192109 {
202109 "type": "string"
212109 },
221056 {
231056 "type": "null"
241056 }
251074 ],
261074 }
274975 },
281231 "required": [
291231 "email"
301231 ],
311245 "type": "object"
324881}
Referenced Components (1)49 of 53 keywords
UserSignupAttribution49 of 53 keywords
13776{
23655 "properties": {
3754 "campaign": {
4754 "anyOf": [
5376 {
6376 "type": "string"
7376 },
8727 {
9727 "type": "null"
10727 }
11754 ],
12754 },
13674 "from_storefront": {
14674 "anyOf": [
15665 {
16660 "format": "uuid4",
17665 "type": "string"
18665 },
19170 {
20170 "type": "null"
21170 }
22674 ],
23674 },
24684 "host": {
25684 "anyOf": [
26171 {
27171 "type": "string"
28171 },
29675 {
30675 "type": "null"
31675 }
32684 ],
33684 },
346415 "intent": {
356415 "anyOf": [
36574 {
37574 "enum": [
381n/a "creator",
391n/a "pledge",
401n/a "purchase",
411n/a "subscription",
421n/a "newsletter_subscription"
43574 ],
441663 "type": "string"
45574 },
465920 {
475920 "type": "null"
485920 }
496415 ],
506415 },
516414 "order": {
526414 "anyOf": [
536315 {
54630 "format": "uuid4",
556315 "type": "string"
566315 },
57177 {
58177 "type": "null"
59177 }
606414 ],
616414 },
62664 "path": {
63664 "anyOf": [
64169 {
65169 "type": "string"
66169 },
67655 {
68655 "type": "null"
69655 }
70664 ],
71664 },
72634 "pledge": {
73634 "anyOf": [
74625 {
75620 "format": "uuid4",
76625 "type": "string"
77625 },
78166 {
79166 "type": "null"
80166 }
81634 ],
82634 },
83634 "subscription": {
84634 "anyOf": [
85625 {
86620 "format": "uuid4",
87625 "type": "string"
88625 },
89166 {
90166 "type": "null"
91166 }
92634 ],
93634 },
94634 "utm_campaign": {
95634 "anyOf": [
96166 {
97166 "type": "string"
98166 },
99625 {
100625 "type": "null"
101625 }
102634 ],
103634 },
104604 "utm_medium": {
105604 "anyOf": [
106163 {
107163 "type": "string"
108163 },
109595 {
110595 "type": "null"
111595 }
112604 ],
113604 },
114584 "utm_source": {
115584 "anyOf": [
116161 {
117161 "type": "string"
118161 },
119575 {
120575 "type": "null"
121575 }
122584 ],
123584 }
1243655 },
1259221 "type": "object"
1263776}
Responses
codedescriptionhitsavg
202Successful Response0never seen
422Validation Error138619ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request11ms
members 1 operation 0 covered 1 partial 0 uncovered 0 not measured 84% #
Query Parameters
customer_id3 / 3
#validinvalidschema
1274n/a{
2274n/a "anyOf": [
3261n/a {
4261n/a "type": "string"
5261n/a },
613261 {
713261 "type": "null"
813261 }
9274n/a ],
10274n/a}
page2 / 2
134544{
234510 "exclusiveMinimum": 0,
335534 "type": "integer"
434544}
limit2 / 2
133435{
233411 "exclusiveMinimum": 0,
334524 "type": "integer"
433435}
sorting4 / 6
115196{
215196 "anyOf": [
315196 {
415196 "items": {
615196 },
72470 "type": "array"
815196 },
90247 {
100247 "type": "null"
110247 }
1215196 ],
1315196}
Referenced Components (1)3 of 3 keywords
MemberSortProperty3 of 3 keywords
1791170{
2791170 "enum": [
3476n/a "created_at",
4315n/a "-created_at"
5791170 ],
6876n/a "type": "string"
7791170}
Responses
codedescriptionhitsavg
200Successful Response2777ms
422Validation Error1285ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1596ms
401Unauthorized593ms
500Internal Server Error11412ms
Examples
Query
1page
10limit
[ "-created_at" ]sorting
meters 5 operations 1 covered 4 partial 0 uncovered 0 not measured 82% #
Query Parameters
organization_id2 / 7
#validinvalidschema
16370{
26370 "anyOf": [
30637 {
400 "format": "uuid4",
50n/a "type": "string",
60637 },
76370 {
86370 "items": {
96370 "format": "uuid4",
10637n/a "type": "string",
116370 },
126370 "type": "array"
136370 },
140637 {
150637 "type": "null"
160637 }
176370 ],
186370}
query3 / 3
1241n/a{
2241n/a "anyOf": [
3194n/a {
4194n/a "type": "string"
5194n/a },
647194 {
747194 "type": "null"
847194 }
9241n/a ],
10241n/a}
is_archived3 / 3
1156140{
2156140 "anyOf": [
3142154 {
4142154 "type": "boolean"
5142154 },
614282 {
714282 "type": "null"
814282 }
9156140 ],
10156140}
page2 / 2
128427{
22848 "exclusiveMinimum": 0,
329219 "type": "integer"
428427}
limit2 / 2
126669{
226619 "exclusiveMinimum": 0,
328550 "type": "integer"
426669}
sorting4 / 6
113858{
213858 "anyOf": [
313858 {
413858 "items": {
613858 },
71960 "type": "array"
813858 },
90196 {
100196 "type": "null"
110196 }
1213858 ],
1313858}
Referenced Components (1)3 of 3 keywords
MeterSortProperty3 of 3 keywords
1629122{
2629122 "enum": [
3158n/a "created_at",
4148n/a "-created_at",
5170n/a "name",
6153n/a "-name"
7629122 ],
8711n/a "type": "string"
9629122}
metadata4 / 13
MetadataQuery
11890{
21890 "anyOf": [
31890 {
41890 "additionalProperties": {
55250 "anyOf": [
6258267 {
7258267 "type": "string"
8258267 },
90525 {
100525 "type": "integer"
110525 },
120525 {
130525 "type": "boolean"
140525 },
15267258 {
162670 "items": {
1726900 "type": "string"
182670 },
19267258 "type": "array"
20267258 },
210525 {
220267 "items": {
2302690 "type": "integer"
240267 },
25267258 "type": "array"
260525 },
270525 {
280267 "items": {
2902690 "type": "boolean"
300267 },
31267258 "type": "array"
320525 }
335250 ]
341890 },
351890 "type": "object"
361890 },
370189 {
380189 "type": "null"
390189 }
401890 ],
411890}
Responses
codedescriptionhitsavg
200Successful Response3658ms
422Validation Error2217ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized413ms
500Internal Server Error101567ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "name" ]sorting
Body
application/json63 / 65
MeterCreate
#validinvalidschema
1397299{
2404282 "properties": {
362361 "aggregation": {
462361 "oneOf": [
5146538 {
7146538 },
8435249 {
10435249 },
1146638 {
1346638 }
1462361 ],
1562361 },
16500184 "filter": {
17500184 "$ref": "#/components/schemas/Filter",
18500184 },
1942316 "metadata": {
20476 "additionalProperties": {
2114710 "anyOf": [
2243114 {
23530 "maxLength": 500,
244310 "minLength": 1,
2553104 "type": "string"
2643114 },
2721136 {
2821136 "type": "integer"
2921136 },
3044113 {
3144113 "type": "number"
3244113 },
336097 {
346097 "type": "boolean"
356097 }
3614710 ]
37476 },
384290 "maxProperties": 50,
39494 "propertyNames": {
401552 "maxLength": 40,
411552 "minLength": 1
42494 },
4342910 "type": "object"
4442316 },
4566815 "name": {
466685 "minLength": 3,
4767310 "type": "string"
4866815 },
496749 "organization_id": {
506749 "anyOf": [
5167211 {
526721 "format": "uuid4",
5367310 "type": "string",
5467211 },
552681 {
562681 "type": "null"
572681 }
586749 ],
596749 }
60404282 },
616797 "required": [
626833 "name",
636842 "filter",
646842 "aggregation"
656797 ],
6668610 "type": "object"
67397299}
Referenced Components (7)54 of 54 keywords
CountAggregation5 of 5 keywords
1146538{
256528 "properties": {
356528 "func": {
456528 "const": "count",
556420 "type": "string"
656528 }
756528 },
867410 "type": "object"
9146538}
Filter11 of 11 keywords
1606619{
2615245 "properties": {
3639217 "clauses": {
4639197 "items": {
5285256 "anyOf": [
6179362 {
8179362 },
9106435 {
10106435 "$ref": "#/components/schemas/Filter"
11106435 }
12285256 ]
13639197 },
1483620 "type": "array"
15639217 },
1682728 "conjunction": {
1882728 }
19615245 },
20851343 "required": [
21855339 "conjunction",
22856338 "clauses"
23851343 ],
24119431 "type": "object"
25606619}
FilterClause15 of 15 keywords
1179362{
2193138 "properties": {
330125 "operator": {
530125 },
630620 "property": {
730620 "type": "string"
830620 },
923393 "value": {
1023393 "anyOf": [
11130196 {
1213012 "maxLength": 1000,
13142184 "type": "string"
14130196 },
1572254 {
161275 "maximum": 2147483647.0,
178250 "minimum": -2147483648.0,
18127199 "type": "integer"
1972254 },
2031295 {
2131295 "type": "boolean"
2231295 }
2323393 ],
2423393 }
25193138 },
26317204 "required": [
27326195 "property",
28326195 "operator",
29326195 "value"
30317204 ],
3152120 "type": "object"
32179362}
FilterConjunction3 of 3 keywords
182728{
282728 "enum": [
3538n/a "and",
4289n/a "or"
582728 ],
683520 "type": "string"
782728}
FilterOperator3 of 3 keywords
130125{
230125 "enum": [
3123n/a "eq",
423n/a "ne",
529n/a "gt",
619n/a "gte",
722n/a "lt",
828n/a "lte",
930n/a "like",
1027n/a "not_like"
1130125 ],
1230620 "type": "string"
1330125}
PropertyAggregation9 of 9 keywords
1435249{
2439152 "properties": {
3448136 "func": {
4448136 "enum": [
5448n/a "sum",
60n/a "max",
70n/a "min",
80n/a "avg"
9448136 ],
1056420 "type": "string"
11448136 },
1249326 "property": {
1349326 "type": "string"
1449326 }
15439152 },
16512162 "required": [
1758490 "func",
18519155 "property"
19512162 ],
2067410 "type": "object"
21435249}
UniqueAggregation8 of 8 keywords
146638{
248543 "properties": {
356528 "func": {
456528 "const": "unique",
556420 "type": "string"
656528 },
749326 "property": {
849326 "type": "string"
949326 }
1048543 },
11519155 "required": [
12519155 "property"
13519155 ],
1467410 "type": "object"
1546638}
Responses
codedescriptionhitsavg
201Meter created.30217ms
422Validation Error3936ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized233ms
500Internal Server Error81514ms
400Bad Request75ms
Examples
Body: application/json
"count"CountAggregation.func
"unique"UniqueAggregation.func
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"MeterCreate.organization_id.examples[0]
Path Parameters
id2 / 2
#validinvalidschema
139518{
239518 "format": "uuid4",
3413n/a "type": "string"
439518}
Responses
codedescriptionhitsavg
200Successful Response3417ms
404Meter not found.117ms
422Validation Error187ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized433ms
Path Parameters
id2 / 2
#validinvalidschema
159010{
259010 "format": "uuid4",
3600n/a "type": "string"
459010}
Body
application/json67 / 69
MeterUpdate
1429145{
2147140 "properties": {
321535 "aggregation": {
421535 "anyOf": [
549201 {
649201 "oneOf": [
721229 {
921229 },
1015235 {
1215235 },
1315235 {
1515235 }
1649201 ]
1749201 },
1816684 {
1916684 "type": "null"
2016684 }
2121535 ],
2221535 },
2313987 "filter": {
2413987 "anyOf": [
2547179 {
2647179 "$ref": "#/components/schemas/Filter",
2747179 },
2892134 {
2992134 "type": "null"
3092134 }
3113987 ],
3213987 },
332227 "is_archived": {
342227 "anyOf": [
3523206 {
3623206 "type": "boolean"
3723206 },
3819930 {
3919930 "type": "null"
4019930 }
412227 ],
422227 },
432168 "metadata": {
44312 "additionalProperties": {
45892 "anyOf": [
463061 {
47320 "maxLength": 500,
48302 "minLength": 1,
493259 "type": "string"
503061 },
512665 {
522665 "type": "integer"
532665 },
543061 {
553061 "type": "number"
563061 },
572962 {
582962 "type": "boolean"
592962 }
60892 ]
61312 },
622180 "maxProperties": 50,
63312 "propertyNames": {
64901 "maxLength": 40,
65901 "minLength": 1
66312 },
672186 "type": "object"
682168 },
692338 "name": {
702338 "anyOf": [
7122714 {
722271 "minLength": 3,
7322813 "type": "string"
7422714 },
756235 {
766235 "type": "null"
776235 }
782338 ],
792338 }
80147140 },
815695 "type": "object"
82429145}
Referenced Components (7)54 of 54 keywords
CountAggregation5 of 5 keywords
121229{
21455 "properties": {
31455 "func": {
41455 "const": "count",
55712 "type": "string"
61455 }
71455 },
876174 "type": "object"
921229}
Filter11 of 11 keywords
174342{
278116 "properties": {
388104 "clauses": {
48894 "items": {
580110 "anyOf": [
653137 {
853137 },
927163 {
1027163 "$ref": "#/components/schemas/Filter"
1127163 }
1280110 ]
138894 },
1418210 "type": "array"
1588104 },
1618012 "conjunction": {
1818012 }
1978116 },
20190119 "required": [
21192117 "conjunction",
22192117 "clauses"
23190119 ],
24309107 "type": "object"
2574342}
FilterClause15 of 15 keywords
153137{
25954 "properties": {
39912 "operator": {
59912 },
68328 "property": {
78328 "type": "string"
88328 },
99714 "value": {
109714 "anyOf": [
115358 {
12532 "maxLength": 1000,
135556 "type": "string"
145358 },
152190 {
16252 "maximum": 2147483647.0,
17252 "minimum": -2147483648.0,
182586 "type": "integer"
192190 },
202388 {
212388 "type": "boolean"
222388 }
239714 ],
249714 }
255954 },
2610772 "required": [
2711168 "property",
2811168 "operator",
2911168 "value"
3010772 ],
3117911 "type": "object"
3253137}
FilterConjunction3 of 3 keywords
118012{
218012 "enum": [
3160n/a "and",
420n/a "or"
518012 ],
618210 "type": "string"
718012}
FilterOperator3 of 3 keywords
19912{
29912 "enum": [
354n/a "eq",
47n/a "ne",
52n/a "gt",
611n/a "gte",
78n/a "lt",
812n/a "lte",
93n/a "like",
102n/a "not_like"
119912 ],
1210110 "type": "string"
139912}
PropertyAggregation9 of 9 keywords
115235{
21753 "properties": {
32148 "func": {
42148 "enum": [
521n/a "sum",
60n/a "max",
70n/a "min",
80n/a "avg"
92148 ],
105712 "type": "string"
112148 },
123610 "property": {
133610 "type": "string"
143610 }
151753 },
164531 "required": [
17697 "func",
184630 "property"
194531 ],
2076174 "type": "object"
2115235}
UniqueAggregation8 of 8 keywords
115235{
21654 "properties": {
32049 "func": {
42049 "const": "unique",
55712 "type": "string"
62049 },
73610 "property": {
83610 "type": "string"
93610 }
101654 },
114630 "required": [
124630 "property"
134630 ],
1476174 "type": "object"
1515235}
Responses
codedescriptionhitsavg
200Meter updated.3767ms
404Meter not found.186ms
422Validation Error1865ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized113ms
500Internal Server Error41811ms
400Bad Request55ms
Examples
Body: application/json
"count"CountAggregation.func
"unique"UniqueAggregation.func
Path Parameters
id2 / 2
#validinvalidschema
156022{
256022 "format": "uuid4",
3582n/a "type": "string"
456022}
Query Parameters
start_timestamp2 / 2
154134{
254134 "format": "date-time",
3575n/a "type": "string"
454134}
end_timestamp2 / 2
154930{
254930 "format": "date-time",
3579n/a "type": "string"
454930}
interval2 / 2
TimeInterval
153730{
253730 "enum": [
374n/a "year",
431n/a "month",
579n/a "week",
6307n/a "day",
746n/a "hour"
853730 ],
9567n/a "type": "string"
1053730}
customer_id4 / 7
11315{
21315 "anyOf": [
30136 {
400 "format": "uuid4",
50n/a "type": "string"
60136 },
71315 {
81315 "items": {
92032 "format": "uuid4",
10205n/a "type": "string"
111315 },
121360 "type": "array"
131315 },
140136 {
150136 "type": "null"
160136 }
171315 ],
181315}
external_customer_id3 / 5
167n/a{
267n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
66777 {
767n/a "items": {
8103n/a "type": "string"
967n/a },
101440 "type": "array"
116777 },
120144 {
130144 "type": "null"
140144 }
1567n/a ],
1667n/a}
customer_aggregation_function5 / 5
111943{
211943 "anyOf": [
39369 {
59369 },
626136 {
726136 "type": "null"
826136 }
911943 ],
1011943}
Referenced Components (1)3 of 3 keywords
AggregationFunction3 of 3 keywords
19369{
29369 "enum": [
360n/a "count",
47n/a "sum",
510n/a "max",
67n/a "min",
73n/a "avg",
86n/a "unique"
99369 ],
10136n/a "type": "string"
119369}
metadata4 / 13
MetadataQuery
1480{
2480 "anyOf": [
3480 {
4480 "additionalProperties": {
5950 "anyOf": [
67619 {
77619 "type": "string"
87619 },
9095 {
10095 "type": "integer"
11095 },
12095 {
13095 "type": "boolean"
14095 },
151976 {
16190 "items": {
171510 "type": "string"
18190 },
191976 "type": "array"
201976 },
21095 {
22019 "items": {
230151 "type": "integer"
24019 },
251976 "type": "array"
26095 },
27095 {
28019 "items": {
290151 "type": "boolean"
30019 },
311976 "type": "array"
32095 }
33950 ]
34480 },
35480 "type": "object"
36480 },
37048 {
38048 "type": "null"
39048 }
40480 ],
41480}
Responses
codedescriptionhitsavg
200Successful Response29810ms
404Meter not found.408ms
422Validation Error2247ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized203ms
metrics 2 operations 1 covered 1 partial 0 uncovered 0 not measured 54% #
Query Parameters
start_date2 / 2
#validinvalidschema
185633{
285633 "format": "date",
3889n/a "type": "string"
485633}
end_date2 / 2
185633{
285633 "format": "date",
3889n/a "type": "string"
485633}
timezone3 / 3
155315{
255315 "enum": [
326n/a "Africa/Abidjan",
41n/a "Africa/Accra",
50n/a "Africa/Addis_Ababa",
60n/a "Africa/Algiers",
70n/a "Africa/Asmara",
80n/a "Africa/Bamako",
90n/a "Africa/Bangui",
100n/a "Africa/Banjul",
110n/a "Africa/Bissau",
121n/a "Africa/Blantyre",
130n/a "Africa/Brazzaville",
140n/a "Africa/Bujumbura",
150n/a "Africa/Cairo",
160n/a "Africa/Casablanca",
170n/a "Africa/Ceuta",
180n/a "Africa/Conakry",
190n/a "Africa/Dakar",
200n/a "Africa/Dar_es_Salaam",
210n/a "Africa/Djibouti",
220n/a "Africa/Douala",
230n/a "Africa/El_Aaiun",
240n/a "Africa/Freetown",
252n/a "Africa/Gaborone",
260n/a "Africa/Harare",
270n/a "Africa/Johannesburg",
280n/a "Africa/Juba",
290n/a "Africa/Kampala",
307n/a "Africa/Khartoum",
311n/a "Africa/Kigali",
320n/a "Africa/Kinshasa",
330n/a "Africa/Lagos",
340n/a "Africa/Libreville",
350n/a "Africa/Lome",
360n/a "Africa/Luanda",
370n/a "Africa/Lubumbashi",
380n/a "Africa/Lusaka",
390n/a "Africa/Malabo",
400n/a "Africa/Maputo",
410n/a "Africa/Maseru",
420n/a "Africa/Mbabane",
430n/a "Africa/Mogadishu",
440n/a "Africa/Monrovia",
451n/a "Africa/Nairobi",
460n/a "Africa/Ndjamena",
471n/a "Africa/Niamey",
480n/a "Africa/Nouakchott",
490n/a "Africa/Ouagadougou",
500n/a "Africa/Porto-Novo",
510n/a "Africa/Sao_Tome",
520n/a "Africa/Timbuktu",
530n/a "Africa/Tripoli",
540n/a "Africa/Tunis",
550n/a "Africa/Windhoek",
560n/a "America/Adak",
570n/a "America/Anchorage",
580n/a "America/Anguilla",
590n/a "America/Antigua",
600n/a "America/Araguaina",
610n/a "America/Argentina/Buenos_Aires",
620n/a "America/Argentina/Catamarca",
630n/a "America/Argentina/Cordoba",
640n/a "America/Argentina/Jujuy",
650n/a "America/Argentina/La_Rioja",
660n/a "America/Argentina/Mendoza",
670n/a "America/Argentina/Rio_Gallegos",
681n/a "America/Argentina/Salta",
690n/a "America/Argentina/San_Juan",
700n/a "America/Argentina/San_Luis",
711n/a "America/Argentina/Tucuman",
721n/a "America/Argentina/Ushuaia",
731n/a "America/Aruba",
741n/a "America/Asuncion",
750n/a "America/Atikokan",
762n/a "America/Atka",
770n/a "America/Bahia",
780n/a "America/Bahia_Banderas",
790n/a "America/Barbados",
800n/a "America/Belem",
810n/a "America/Belize",
820n/a "America/Blanc-Sablon",
830n/a "America/Boa_Vista",
845n/a "America/Bogota",
850n/a "America/Boise",
860n/a "America/Cambridge_Bay",
871n/a "America/Campo_Grande",
880n/a "America/Cancun",
890n/a "America/Caracas",
901n/a "America/Cayenne",
910n/a "America/Cayman",
920n/a "America/Chicago",
930n/a "America/Chihuahua",
940n/a "America/Ciudad_Juarez",
950n/a "America/Coral_Harbour",
960n/a "America/Costa_Rica",
971n/a "America/Coyhaique",
981n/a "America/Creston",
992n/a "America/Cuiaba",
1001n/a "America/Curacao",
1011n/a "America/Danmarkshavn",
1021n/a "America/Dawson",
1031n/a "America/Dawson_Creek",
1041n/a "America/Denver",
1051n/a "America/Detroit",
1061n/a "America/Dominica",
1071n/a "America/Edmonton",
1081n/a "America/Eirunepe",
1091n/a "America/El_Salvador",
1101n/a "America/Ensenada",
1111n/a "America/Fort_Nelson",
1121n/a "America/Fortaleza",
1131n/a "America/Glace_Bay",
1141n/a "America/Goose_Bay",
1151n/a "America/Grand_Turk",
1161n/a "America/Grenada",
1171n/a "America/Guadeloupe",
1181n/a "America/Guatemala",
1192n/a "America/Guayaquil",
1201n/a "America/Guyana",
1211n/a "America/Halifax",
1221n/a "America/Havana",
1231n/a "America/Hermosillo",
1241n/a "America/Indiana/Indianapolis",
1251n/a "America/Indiana/Knox",
1261n/a "America/Indiana/Marengo",
1271n/a "America/Indiana/Petersburg",
1281n/a "America/Indiana/Tell_City",
1291n/a "America/Indiana/Vevay",
1301n/a "America/Indiana/Vincennes",
1311n/a "America/Indiana/Winamac",
1321n/a "America/Inuvik",
1331n/a "America/Iqaluit",
1341n/a "America/Jamaica",
1351n/a "America/Juneau",
1361n/a "America/Kentucky/Louisville",
1371n/a "America/Kentucky/Monticello",
1387n/a "America/Kralendijk",
1391n/a "America/La_Paz",
1402n/a "America/Lima",
1411n/a "America/Los_Angeles",
1421n/a "America/Lower_Princes",
1431n/a "America/Maceio",
1441n/a "America/Managua",
1451n/a "America/Manaus",
1462n/a "America/Marigot",
1471n/a "America/Martinique",
1481n/a "America/Matamoros",
1491n/a "America/Mazatlan",
1501n/a "America/Menominee",
1512n/a "America/Merida",
1521n/a "America/Metlakatla",
1531n/a "America/Mexico_City",
1541n/a "America/Miquelon",
1551n/a "America/Moncton",
1561n/a "America/Monterrey",
1571n/a "America/Montevideo",
1581n/a "America/Montreal",
1591n/a "America/Montserrat",
1602n/a "America/Nassau",
1611n/a "America/New_York",
1621n/a "America/Nipigon",
1631n/a "America/Nome",
1641n/a "America/Noronha",
1651n/a "America/North_Dakota/Beulah",
1661n/a "America/North_Dakota/Center",
1671n/a "America/North_Dakota/New_Salem",
1681n/a "America/Nuuk",
1691n/a "America/Ojinaga",
1701n/a "America/Panama",
1713n/a "America/Pangnirtung",
1721n/a "America/Paramaribo",
1731n/a "America/Phoenix",
1741n/a "America/Port-au-Prince",
1751n/a "America/Port_of_Spain",
1761n/a "America/Porto_Acre",
1771n/a "America/Porto_Velho",
1781n/a "America/Puerto_Rico",
1791n/a "America/Punta_Arenas",
1801n/a "America/Rainy_River",
1811n/a "America/Rankin_Inlet",
1821n/a "America/Recife",
1831n/a "America/Regina",
1841n/a "America/Resolute",
1852n/a "America/Rio_Branco",
1861n/a "America/Santa_Isabel",
1871n/a "America/Santarem",
1881n/a "America/Santiago",
1893n/a "America/Santo_Domingo",
1901n/a "America/Sao_Paulo",
1911n/a "America/Scoresbysund",
1921n/a "America/Shiprock",
1931n/a "America/Sitka",
1941n/a "America/St_Barthelemy",
1951n/a "America/St_Johns",
1961n/a "America/St_Kitts",
1971n/a "America/St_Lucia",
1981n/a "America/St_Thomas",
1991n/a "America/St_Vincent",
2001n/a "America/Swift_Current",
2011n/a "America/Tegucigalpa",
2022n/a "America/Thule",
2031n/a "America/Thunder_Bay",
2041n/a "America/Tijuana",
2051n/a "America/Toronto",
2061n/a "America/Tortola",
2071n/a "America/Vancouver",
2081n/a "America/Virgin",
2091n/a "America/Whitehorse",
2101n/a "America/Winnipeg",
2111n/a "America/Yakutat",
2121n/a "America/Yellowknife",
2132n/a "Antarctica/Casey",
2142n/a "Antarctica/Davis",
2151n/a "Antarctica/DumontDUrville",
2161n/a "Antarctica/Macquarie",
2171n/a "Antarctica/Mawson",
2182n/a "Antarctica/McMurdo",
2191n/a "Antarctica/Palmer",
2201n/a "Antarctica/Rothera",
2211n/a "Antarctica/Syowa",
2221n/a "Antarctica/Troll",
2231n/a "Antarctica/Vostok",
2241n/a "Arctic/Longyearbyen",
2251n/a "Asia/Aden",
2262n/a "Asia/Almaty",
2271n/a "Asia/Amman",
2281n/a "Asia/Anadyr",
2291n/a "Asia/Aqtau",
2301n/a "Asia/Aqtobe",
2311n/a "Asia/Ashgabat",
2321n/a "Asia/Atyrau",
2331n/a "Asia/Baghdad",
2341n/a "Asia/Bahrain",
2352n/a "Asia/Baku",
2361n/a "Asia/Bangkok",
2371n/a "Asia/Barnaul",
2381n/a "Asia/Beirut",
2391n/a "Asia/Bishkek",
2401n/a "Asia/Brunei",
2411n/a "Asia/Chita",
2421n/a "Asia/Chongqing",
2431n/a "Asia/Colombo",
2442n/a "Asia/Damascus",
2451n/a "Asia/Dhaka",
2461n/a "Asia/Dili",
2472n/a "Asia/Dubai",
2481n/a "Asia/Dushanbe",
2491n/a "Asia/Famagusta",
2501n/a "Asia/Gaza",
2511n/a "Asia/Harbin",
2521n/a "Asia/Hebron",
2531n/a "Asia/Ho_Chi_Minh",
2541n/a "Asia/Hong_Kong",
2552n/a "Asia/Hovd",
2561n/a "Asia/Irkutsk",
2571n/a "Asia/Istanbul",
2582n/a "Asia/Jakarta",
2591n/a "Asia/Jayapura",
2601n/a "Asia/Jerusalem",
2611n/a "Asia/Kabul",
2621n/a "Asia/Kamchatka",
2631n/a "Asia/Karachi",
2641n/a "Asia/Kashgar",
2651n/a "Asia/Kathmandu",
2661n/a "Asia/Khandyga",
2671n/a "Asia/Kolkata",
2681n/a "Asia/Krasnoyarsk",
2691n/a "Asia/Kuala_Lumpur",
2701n/a "Asia/Kuching",
2711n/a "Asia/Kuwait",
2721n/a "Asia/Macau",
2731n/a "Asia/Magadan",
2742n/a "Asia/Makassar",
2751n/a "Asia/Manila",
2761n/a "Asia/Muscat",
2771n/a "Asia/Nicosia",
2781n/a "Asia/Novokuznetsk",
2791n/a "Asia/Novosibirsk",
2801n/a "Asia/Omsk",
2811n/a "Asia/Oral",
2821n/a "Asia/Phnom_Penh",
2831n/a "Asia/Pontianak",
2841n/a "Asia/Pyongyang",
2851n/a "Asia/Qatar",
2861n/a "Asia/Qostanay",
2871n/a "Asia/Qyzylorda",
2881n/a "Asia/Riyadh",
2891n/a "Asia/Sakhalin",
2901n/a "Asia/Samarkand",
2911n/a "Asia/Seoul",
2921n/a "Asia/Shanghai",
2931n/a "Asia/Singapore",
2941n/a "Asia/Srednekolymsk",
2951n/a "Asia/Taipei",
2961n/a "Asia/Tashkent",
2971n/a "Asia/Tbilisi",
2981n/a "Asia/Tehran",
2991n/a "Asia/Tel_Aviv",
3001n/a "Asia/Thimphu",
3011n/a "Asia/Tokyo",
3021n/a "Asia/Tomsk",
3031n/a "Asia/Ulaanbaatar",
3041n/a "Asia/Urumqi",
3051n/a "Asia/Ust-Nera",
3061n/a "Asia/Vientiane",
3071n/a "Asia/Vladivostok",
3081n/a "Asia/Yakutsk",
3091n/a "Asia/Yangon",
3101n/a "Asia/Yekaterinburg",
3111n/a "Asia/Yerevan",
3121n/a "Atlantic/Azores",
3131n/a "Atlantic/Bermuda",
3141n/a "Atlantic/Canary",
3151n/a "Atlantic/Cape_Verde",
3161n/a "Atlantic/Faroe",
3171n/a "Atlantic/Jan_Mayen",
3181n/a "Atlantic/Madeira",
3191n/a "Atlantic/Reykjavik",
3201n/a "Atlantic/South_Georgia",
3211n/a "Atlantic/St_Helena",
3221n/a "Atlantic/Stanley",
3231n/a "Australia/Adelaide",
3241n/a "Australia/Brisbane",
3251n/a "Australia/Broken_Hill",
3261n/a "Australia/Canberra",
3271n/a "Australia/Currie",
3281n/a "Australia/Darwin",
3291n/a "Australia/Eucla",
3301n/a "Australia/Hobart",
3311n/a "Australia/Lindeman",
3321n/a "Australia/Lord_Howe",
3331n/a "Australia/Melbourne",
3342n/a "Australia/Perth",
3351n/a "Australia/Sydney",
3361n/a "Australia/Yancowinna",
3371n/a "Etc/GMT",
3381n/a "Etc/GMT+0",
3391n/a "Etc/GMT+1",
3401n/a "Etc/GMT+10",
3411n/a "Etc/GMT+11",
3421n/a "Etc/GMT+12",
3432n/a "Etc/GMT+2",
3442n/a "Etc/GMT+3",
3451n/a "Etc/GMT+4",
3461n/a "Etc/GMT+5",
3471n/a "Etc/GMT+6",
3481n/a "Etc/GMT+7",
3491n/a "Etc/GMT+8",
3502n/a "Etc/GMT+9",
3512n/a "Etc/GMT-0",
3521n/a "Etc/GMT-1",
3531n/a "Etc/GMT-10",
3541n/a "Etc/GMT-11",
3551n/a "Etc/GMT-12",
3562n/a "Etc/GMT-13",
3571n/a "Etc/GMT-14",
3581n/a "Etc/GMT-2",
3591n/a "Etc/GMT-3",
3602n/a "Etc/GMT-4",
3611n/a "Etc/GMT-5",
3621n/a "Etc/GMT-6",
3631n/a "Etc/GMT-7",
3641n/a "Etc/GMT-8",
3652n/a "Etc/GMT-9",
3661n/a "Etc/GMT0",
3671n/a "Etc/Greenwich",
3681n/a "Etc/UCT",
3691n/a "Etc/UTC",
3701n/a "Etc/Universal",
3711n/a "Etc/Zulu",
3721n/a "Europe/Amsterdam",
3732n/a "Europe/Andorra",
3741n/a "Europe/Astrakhan",
3751n/a "Europe/Athens",
3761n/a "Europe/Belfast",
3771n/a "Europe/Belgrade",
3783n/a "Europe/Berlin",
3791n/a "Europe/Bratislava",
3801n/a "Europe/Brussels",
3811n/a "Europe/Bucharest",
3821n/a "Europe/Budapest",
3831n/a "Europe/Busingen",
3841n/a "Europe/Chisinau",
3851n/a "Europe/Copenhagen",
3861n/a "Europe/Dublin",
3872n/a "Europe/Gibraltar",
3881n/a "Europe/Guernsey",
3891n/a "Europe/Helsinki",
3901n/a "Europe/Isle_of_Man",
3911n/a "Europe/Istanbul",
3921n/a "Europe/Jersey",
3931n/a "Europe/Kaliningrad",
3941n/a "Europe/Kirov",
3951n/a "Europe/Kyiv",
3961n/a "Europe/Lisbon",
3972n/a "Europe/Ljubljana",
3981n/a "Europe/London",
3991n/a "Europe/Luxembourg",
4001n/a "Europe/Madrid",
4011n/a "Europe/Malta",
4021n/a "Europe/Mariehamn",
4031n/a "Europe/Minsk",
4043n/a "Europe/Monaco",
4051n/a "Europe/Moscow",
4061n/a "Europe/Nicosia",
4071n/a "Europe/Oslo",
4081n/a "Europe/Paris",
4091n/a "Europe/Podgorica",
4101n/a "Europe/Prague",
4111n/a "Europe/Riga",
4121n/a "Europe/Rome",
4131n/a "Europe/Samara",
4141n/a "Europe/San_Marino",
4151n/a "Europe/Sarajevo",
4161n/a "Europe/Saratov",
4171n/a "Europe/Simferopol",
4182n/a "Europe/Skopje",
4191n/a "Europe/Sofia",
4201n/a "Europe/Stockholm",
4211n/a "Europe/Tallinn",
4221n/a "Europe/Tirane",
4231n/a "Europe/Tiraspol",
4242n/a "Europe/Ulyanovsk",
4251n/a "Europe/Vaduz",
4261n/a "Europe/Vatican",
4274n/a "Europe/Vienna",
4281n/a "Europe/Vilnius",
4291n/a "Europe/Volgograd",
4301n/a "Europe/Warsaw",
4312n/a "Europe/Zagreb",
4321n/a "Europe/Zurich",
4331n/a "Factory",
43413n/a "GMT",
4351n/a "Indian/Antananarivo",
4361n/a "Indian/Chagos",
4371n/a "Indian/Christmas",
4381n/a "Indian/Cocos",
4391n/a "Indian/Comoro",
4401n/a "Indian/Kerguelen",
4411n/a "Indian/Mahe",
4421n/a "Indian/Maldives",
4431n/a "Indian/Mauritius",
4441n/a "Indian/Mayotte",
4451n/a "Indian/Reunion",
4461n/a "Pacific/Apia",
4472n/a "Pacific/Auckland",
4481n/a "Pacific/Bougainville",
4491n/a "Pacific/Chatham",
4501n/a "Pacific/Chuuk",
4511n/a "Pacific/Easter",
4521n/a "Pacific/Efate",
4531n/a "Pacific/Fakaofo",
4547n/a "Pacific/Fiji",
4551n/a "Pacific/Funafuti",
4561n/a "Pacific/Galapagos",
4576n/a "Pacific/Gambier",
4581n/a "Pacific/Guadalcanal",
4592n/a "Pacific/Guam",
4601n/a "Pacific/Honolulu",
4611n/a "Pacific/Johnston",
4621n/a "Pacific/Kanton",
4631n/a "Pacific/Kiritimati",
4641n/a "Pacific/Kosrae",
4651n/a "Pacific/Kwajalein",
4661n/a "Pacific/Majuro",
4671n/a "Pacific/Marquesas",
4681n/a "Pacific/Midway",
4691n/a "Pacific/Nauru",
4701n/a "Pacific/Niue",
4713n/a "Pacific/Norfolk",
4721n/a "Pacific/Noumea",
4731n/a "Pacific/Pago_Pago",
4741n/a "Pacific/Palau",
4751n/a "Pacific/Pitcairn",
4766n/a "Pacific/Pohnpei",
4771n/a "Pacific/Port_Moresby",
4782n/a "Pacific/Rarotonga",
4792n/a "Pacific/Saipan",
4801n/a "Pacific/Samoa",
4811n/a "Pacific/Tahiti",
4821n/a "Pacific/Tarawa",
4831n/a "Pacific/Tongatapu",
4841n/a "Pacific/Wake",
4851n/a "Pacific/Wallis",
4862n/a "Pacific/Yap",
48724n/a "UTC",
4881n/a "localtime"
48955315 ],
4905653 "minLength": 1,
491568n/a "type": "string"
49255315}
interval2 / 2
TimeInterval
185138{
285138 "enum": [
3468n/a "year",
432n/a "month",
544n/a "week",
6276n/a "day",
731n/a "hour"
885138 ],
9889n/a "type": "string"
1085138}
organization_id2 / 7
18950{
28950 "anyOf": [
30895 {
400 "format": "uuid4",
50n/a "type": "string",
60895 },
78950 {
88950 "items": {
98950 "format": "uuid4",
10895n/a "type": "string",
118950 },
128950 "type": "array"
138950 },
140895 {
150895 "type": "null"
160895 }
178950 ],
188950}
product_id4 / 7
17631{
27631 "anyOf": [
30764 {
400 "format": "uuid4",
50n/a "type": "string",
60764 },
77631 {
87631 "items": {
97818 "format": "uuid4",
10789n/a "type": "string",
117631 },
127640 "type": "array"
137631 },
140764 {
150764 "type": "null"
160764 }
177631 ],
187631}
billing_type4 / 7
150513{
250513 "anyOf": [
30518 {
50518 },
650513 {
750513 "items": {
950513 },
105180 "type": "array"
1150513 },
120518 {
130518 "type": "null"
140518 }
1550513 ],
1650513}
Referenced Components (1)3 of 3 keywords
ProductBillingType3 of 3 keywords
1709533{
2709533 "enum": [
3586n/a "one_time",
4123n/a "recurring"
5709533 ],
6711n/a "type": "string"
7709533}
customer_id4 / 7
151611{
251611 "anyOf": [
30527 {
400 "format": "uuid4",
50n/a "type": "string"
60527 },
751611 {
851611 "items": {
968712 "format": "uuid4",
10699n/a "type": "string"
1151611 },
125270 "type": "array"
1351611 },
140527 {
150527 "type": "null"
160527 }
1751611 ],
1851611}
Responses
codedescriptionhitsavg
200Successful Response60922ms
422Validation Error2006ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized353ms
500Internal Server Error511002ms
Examples
Query
"UTC"timezone
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
Responses
codedescriptionhitsavg
200Successful Response335ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4292ms
notifications 5 operations 4 covered 1 partial 0 uncovered 0 not measured 96% #
Responses
codedescriptionhitsavg
200Successful Response316ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4282ms
Body
application/json4 / 5
NotificationsMarkRead
#validinvalidschema
140422{
24045 "properties": {
34045 "notification_id": {
44040 "format": "uuid4",
54045 "type": "string"
64045 }
74045 },
840911 "required": [
940911 "notification_id"
1040911 ],
114206 "type": "object"
1240422}
Responses
codedescriptionhitsavg
200Successful Response3518ms
422Validation Error395ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized532ms
Query Parameters
expo_push_token3 / 3
#validinvalidschema
1336n/a{
2336n/a "anyOf": [
3280n/a {
4280n/a "type": "string"
5280n/a },
656280 {
756280 "type": "null"
856280 }
9336n/a ],
10336n/a}
platform5 / 5
196199{
296199 "anyOf": [
391204 {
591204 },
65290 {
75290 "type": "null"
85290 }
996199 ],
1096199}
Referenced Components (1)3 of 3 keywords
NotificationRecipientPlatform3 of 3 keywords
191204{
291204 "enum": [
348n/a "ios",
443n/a "android"
591204 ],
6290n/a "type": "string"
791204}
page2 / 2
119278{
219240 "exclusiveMinimum": 0,
323238 "type": "integer"
419278}
limit2 / 2
119277{
219225 "exclusiveMinimum": 0,
321752 "type": "integer"
419277}
Responses
codedescriptionhitsavg
200Successful Response3137ms
422Validation Error2526ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized462ms
500Internal Server Error11348ms
Examples
Query
1page
10limit
Body
application/json7 / 7
NotificationRecipientCreate
#validinvalidschema
148486{
252342 "properties": {
35518 "expo_push_token": {
45518 "type": "string"
55518 },
649735 "platform": {
849735 }
952342 },
1052639 "required": [
1153233 "platform",
125596 "expo_push_token"
1352639 ],
145655 "type": "object"
1548486}
Referenced Components (1)3 of 3 keywords
NotificationRecipientPlatform3 of 3 keywords
149735{
249735 "enum": [
3316n/a "ios",
4181n/a "android"
549735 ],
65257 "type": "string"
749735}
Responses
codedescriptionhitsavg
201Device subscribed to notifications.7317ms
422Validation Error4336ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized952ms
400Bad Request115ms
500Internal Server Error11443ms
Path Parameters
id2 / 2
#validinvalidschema
1351{
2351 "format": "uuid4",
336n/a "type": "string"
4351}
Responses
codedescriptionhitsavg
204Notification recipient unsubscribed from notifications.3214ms
404Notification recipient not found.0never seen
422Validation Error16ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized33ms
oauth2 11 operations 9 covered 1 partial 1 uncovered 0 not measured 84% #
Query Parameters
page2 / 2
#validinvalidschema
1118244{
2118188 "exclusiveMinimum": 0,
330656 "type": "integer"
4118244}
limit2 / 2
1128232{
212859 "exclusiveMinimum": 0,
3187173 "type": "integer"
4128232}
Responses
codedescriptionhitsavg
200Successful Response2468ms
422Validation Error2617ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized322ms
500Internal Server Error81400ms
Examples
Query
1page
10limit
Responses
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4233ms
Body
application/x-www-form-urlencoded5 / 5
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error1865ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2056ms
401Unauthorized432ms
Body
application/x-www-form-urlencoded10 / 10
IntrospectTokenRequest
#validinvalidschema
139452{
24379 "properties": {
3444n/a "client_id": {
4444n/a "type": "string"
5444n/a },
6445n/a "client_secret": {
7445n/a "type": "string"
8445n/a },
9406n/a "token": {
10406n/a "type": "string"
11406n/a },
121409 "token_type_hint": {
131409 "anyOf": [
145297 {
155297 "enum": [
1631n/a "access_token",
1721n/a "refresh_token"
185297 ],
1961n/a "type": "string"
205297 },
218861 {
228861 "type": "null"
238861 }
241409 ],
251409 }
264379 },
2740343 "required": [
2840640 "token",
294442 "client_id",
304451 "client_secret"
3140343 ],
32446n/a "type": "object"
3339452}
Responses
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4503ms
Examples
Body: application/x-www-form-urlencoded
nullIntrospectTokenRequest.token_type_hint
Body
application/json41 / 41
OAuth2ClientConfiguration
#validinvalidschema
1912137{
2916124 "properties": {
310326 "client_name": {
410326 "type": "string"
510326 },
634619 "client_uri": {
734619 "anyOf": [
8176189 {
9176189 "type": "string"
10176189 },
11170195 {
12170195 "type": "null"
13170195 }
1434619 ],
1534619 },
1633214 "default_sub_type": {
1733214 "$ref": "#/components/schemas/SubType",
1833214 },
1932713 "grant_types": {
203278 "items": {
2110028 "enum": [
22446n/a "authorization_code",
23556n/a "refresh_token"
2410028 ],
2510055 "type": "string"
263278 },
273355 "type": "array"
2832713 },
2929516 "logo_uri": {
3029516 "anyOf": [
3126843 {
322693 "format": "uri",
332711 "maxLength": 2083,
342711 "minLength": 1,
3527239 "type": "string"
3626843 },
3727284 {
3827284 "type": "null"
3927284 }
4029516 ],
4129516 },
4230319 "policy_uri": {
4330319 "anyOf": [
4427646 {
452773 "format": "uri",
462791 "maxLength": 2083,
472791 "minLength": 1,
4828042 "type": "string"
4927646 },
5027295 {
5127295 "type": "null"
5227295 }
5330319 ],
5430319 },
55101226 "redirect_uris": {
56101221 "items": {
57197919 "format": "uri",
58198018 "minLength": 1,
5919985 "type": "string"
60101221 },
6110335 "type": "array"
62101226 },
6331111 "response_types": {
643116 "items": {
6510176 "const": "code",
6610185 "type": "string"
673116 },
683175 "type": "array"
6931111 },
702988 "scope": {
712988 "type": "string"
722988 },
732989 "token_endpoint_auth_method": {
742989 "enum": [
7557n/a "client_secret_basic",
76180n/a "client_secret_post",
7761n/a "none"
782989 ],
793025 "type": "string"
802989 },
813028 "tos_uri": {
823028 "anyOf": [
8325357 {
842543 "format": "uri",
852561 "maxLength": 2083,
862561 "minLength": 1,
8725753 "type": "string"
8825357 },
8949261 {
9049261 "type": "null"
9149261 }
923028 ],
933028 }
94916124 },
9510368 "required": [
9610386 "redirect_uris",
9710386 "client_name"
9810368 ],
9910445 "type": "object"
100912137}
Referenced Components (1)3 of 3 keywords
SubType3 of 3 keywords
133214{
233214 "enum": [
3121n/a "user",
4211n/a "organization"
533214 ],
63388 "type": "string"
733214}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error1625ms
Undocumented - not in spec
codedescriptionhitsavg
201Created8747ms
400Bad Request545ms
Examples
Body: application/json
"organization"OAuth2ClientConfiguration.default_sub_type
[ "authorization_code", "refresh_token" ]OAuth2ClientConfiguration.grant_types
[ "code" ]OAuth2ClientConfiguration.response_types
"openid profile email user:read organizations:read organizations:write custom_fields:read custom_fields:write discounts:read discounts:write checkout_links:read checkout_links:write checkouts:read checkouts:write transactions:read transactions:write payouts:read payouts:write products:read products:write benefits:read benefits:write events:read events:write meters:read meters:write files:read files:write subscriptions:read subscriptions:write customers:read customers:write members:read members:write wallets:read wallets:write customer_meters:read customer_sessions:write customer_seats:read customer_seats:write orders:read orders:write refunds:read refunds:write payments:read metrics:read webhooks:read webhooks:write external_organizations:read license_keys:read license_keys:write repositories:read repositories:write issues:read issues:write customer_portal:read customer_portal:write notifications:read notifications:write notification_recipients:read notification_recipients:write"OAuth2ClientConfiguration.scope
"client_secret_post"OAuth2ClientConfiguration.token_endpoint_auth_method
Path Parameters
client_id1 / 1
#validinvalidschema
170n/a{
270n/a "type": "string"
370n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized37ms
204No Content318ms
400Bad Request362ms
Path Parameters
client_id1 / 1
#validinvalidschema
1573n/a{
2573n/a "type": "string"
3573n/a}
Responses
codedescriptionhitsavg
200Successful Response1426ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized246ms
400Bad Request4072ms
Path Parameters
client_id1 / 1
#validinvalidschema
1651n/a{
2651n/a "type": "string"
3651n/a}
Body
application/json42 / 42
OAuth2ClientConfigurationUpdate
1496127{
2506112 "properties": {
36125 "client_id": {
46125 "type": "string"
56125 },
66098 "client_name": {
76098 "type": "string"
86098 },
918513 "client_uri": {
1018513 "anyOf": [
1162136 {
1262136 "type": "string"
1362136 },
1412375 {
1512375 "type": "null"
1612375 }
1718513 ],
1818513 },
1918010 "default_sub_type": {
2018010 "$ref": "#/components/schemas/SubType",
2118010 },
2216316 "grant_types": {
231639 "items": {
244589 "enum": [
25225n/a "authorization_code",
26233n/a "refresh_token"
274589 ],
284625 "type": "string"
291639 },
301727 "type": "array"
3116316 },
321669 "logo_uri": {
331669 "anyOf": [
3414332 {
351443 "format": "uri",
361461 "maxLength": 2083,
371461 "minLength": 1,
3814728 "type": "string"
3914332 },
4023152 {
4123152 "type": "null"
4223152 }
431669 ],
441669 },
4517310 "policy_uri": {
4617310 "anyOf": [
4716518 {
481663 "format": "uri",
491681 "maxLength": 2083,
501681 "minLength": 1,
5116914 "type": "string"
5216518 },
538175 {
548175 "type": "null"
558175 }
5617310 ],
5717310 },
5859317 "redirect_uris": {
5959312 "items": {
607877 "format": "uri",
617886 "minLength": 1,
627945 "type": "string"
6359312 },
646055 "type": "array"
6559317 },
6616012 "response_types": {
671607 "items": {
684067 "const": "code",
694085 "type": "string"
701607 },
711675 "type": "array"
7216012 },
731747 "scope": {
741747 "type": "string"
751747 },
761706 "token_endpoint_auth_method": {
771706 "enum": [
7837n/a "client_secret_basic",
79116n/a "client_secret_post",
8017n/a "none"
811706 ],
821715 "type": "string"
831706 },
841798 "tos_uri": {
851798 "anyOf": [
8616621 {
871673 "format": "uri",
881691 "maxLength": 2083,
891691 "minLength": 1,
9017017 "type": "string"
9116621 },
9213174 {
9313174 "type": "null"
9413174 }
951798 ],
961798 }
97506112 },
9860810 "required": [
996108 "redirect_uris",
1006171 "client_name",
1016171 "client_id"
10260810 ],
1036185 "type": "object"
104496127}
Referenced Components (1)3 of 3 keywords
SubType3 of 3 keywords
118010{
218010 "enum": [
334n/a "user",
4146n/a "organization"
518010 ],
61837 "type": "string"
718010}
Responses
codedescriptionhitsavg
200Successful Response966ms
422Validation Error1505ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1376ms
400Bad Request2685ms
Examples
Body: application/json
"organization"OAuth2ClientConfigurationUpdate.default_sub_type
[ "authorization_code", "refresh_token" ]OAuth2ClientConfigurationUpdate.grant_types
[ "code" ]OAuth2ClientConfigurationUpdate.response_types
"openid profile email user:read organizations:read organizations:write custom_fields:read custom_fields:write discounts:read discounts:write checkout_links:read checkout_links:write checkouts:read checkouts:write transactions:read transactions:write payouts:read payouts:write products:read products:write benefits:read benefits:write events:read events:write meters:read meters:write files:read files:write subscriptions:read subscriptions:write customers:read customers:write members:read members:write wallets:read wallets:write customer_meters:read customer_sessions:write customer_seats:read customer_seats:write orders:read orders:write refunds:read refunds:write payments:read metrics:read webhooks:read webhooks:write external_organizations:read license_keys:read license_keys:write repositories:read repositories:write issues:read issues:write customer_portal:read customer_portal:write notifications:read notifications:write notification_recipients:read notification_recipients:write"OAuth2ClientConfigurationUpdate.scope
"client_secret_post"OAuth2ClientConfigurationUpdate.token_endpoint_auth_method
Body
application/x-www-form-urlencodedno coverage data
RevokeTokenRequest
#validinvalidschema
100{
200 "properties": {
30n/a "client_id": {
40n/a "type": "string"
50n/a },
60n/a "client_secret": {
70n/a "type": "string"
80n/a },
90n/a "token": {
100n/a "type": "string"
110n/a },
1200 "token_type_hint": {
1300 "anyOf": [
1400 {
1500 "enum": [
160n/a "access_token",
170n/a "refresh_token"
1800 ],
190n/a "type": "string"
2000 },
2100 {
2200 "type": "null"
2300 }
2400 ],
2500 }
2600 },
2700 "required": [
2800 "token",
2900 "client_id",
3000 "client_secret"
3100 ],
320n/a "type": "object"
3300}
Expected Responses
codedescriptionhitsavg
200Successful Response0never seen
Body
application/x-www-form-urlencoded27 / 41
#validinvalidschema
1263137{
2263137 "oneOf": [
353347 {
553347 },
6113287 {
8113287 },
997303 {
1197303 }
12263137 ]
13263137}
Referenced Components (3)32 of 46 keywords
AuthorizationCodeTokenRequest10 of 14 keywords
153347{
268307 "properties": {
33620 "client_id": {
43620 "type": "string"
53620 },
63680 "client_secret": {
73680 "type": "string"
83680 },
9992 "code": {
10992 "type": "string"
11992 },
1284284 "grant_type": {
1384284 "const": "authorization_code",
143680 "type": "string"
1584284 },
167625 "redirect_uri": {
177723 "format": "uri",
188218 "maxLength": 2083,
19955 "minLength": 1,
201001 "type": "string"
217625 }
2268307 },
2393307 "required": [
2436832 "grant_type",
2536238 "client_id",
2636832 "client_secret",
27101299 "code",
28101299 "redirect_uri"
2993307 ],
304000 "type": "object"
3153347}
RefreshTokenRequest5 of 10 keywords
1113287{
2126249 "properties": {
33620 "client_id": {
43620 "type": "string"
53620 },
63680 "client_secret": {
73680 "type": "string"
83680 },
9119249 "grant_type": {
10119249 "const": "refresh_token",
113680 "type": "string"
12119249 },
131260 "refresh_token": {
141260 "type": "string"
151260 }
16126249 },
17120280 "required": [
1836832 "grant_type",
1936238 "client_id",
2036832 "client_secret",
21126274 "refresh_token"
22120280 ],
234000 "type": "object"
24113287}
WebTokenRequest17 of 22 keywords
197303{
2117259 "properties": {
33620 "client_id": {
43620 "type": "string"
53620 },
63680 "client_secret": {
73680 "type": "string"
83680 },
9136232 "grant_type": {
10136232 "const": "web",
113680 "type": "string"
12136232 },
135212 "scope": {
145212 "anyOf": [
151945 {
161945 "type": "string"
171945 },
183331 {
193331 "type": "null"
203331 }
215212 ],
225212 },
231362 "session_token": {
241362 "type": "string"
251362 },
263914 "sub": {
273914 "anyOf": [
281637 {
291610 "format": "uuid4",
302627 "type": "string"
311637 },
322330 {
332330 "type": "null"
342330 }
353914 ],
363914 },
37364 "sub_type": {
38364 "enum": [
3922n/a "user",
4014n/a "organization"
41364 ],
42400 "type": "string"
43364 }
44117259 },
45129271 "required": [
4636832 "grant_type",
4736238 "client_id",
4836832 "client_secret",
49138262 "session_token"
50129271 ],
514000 "type": "object"
5297303}
Responses
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4703ms
Examples
Body: application/x-www-form-urlencoded
nullWebTokenRequest.scope
nullWebTokenRequest.sub
"user"WebTokenRequest.sub_type
Responses
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized72ms
orders 6 operations 4 covered 2 partial 0 uncovered 0 not measured 60% #
Query Parameters
organization_id2 / 7
#validinvalidschema
17110{
27110 "anyOf": [
30711 {
400 "format": "uuid4",
50n/a "type": "string",
60711 },
77110 {
87110 "items": {
97110 "format": "uuid4",
10711n/a "type": "string",
117110 },
127110 "type": "array"
137110 },
140711 {
150711 "type": "null"
160711 }
177110 ],
187110}
product_id4 / 7
15954{
25954 "anyOf": [
30599 {
400 "format": "uuid4",
50n/a "type": "string",
60599 },
75954 {
85954 "items": {
96061 "format": "uuid4",
10607n/a "type": "string",
115954 },
125990 "type": "array"
135954 },
140599 {
150599 "type": "null"
160599 }
175954 ],
185954}
product_billing_type4 / 7
129018{
229018 "anyOf": [
30308 {
50308 },
629018 {
729018 "items": {
929018 },
103080 "type": "array"
1129018 },
120308 {
130308 "type": "null"
140308 }
1529018 ],
1629018}
Referenced Components (1)3 of 3 keywords
ProductBillingType3 of 3 keywords
1958328{
2958328 "enum": [
3599n/a "one_time",
4359n/a "recurring"
5958328 ],
6961n/a "type": "string"
7958328}
discount_id4 / 7
13065{
23065 "anyOf": [
30311 {
400 "format": "uuid4",
50n/a "type": "string"
60311 },
73065 {
83065 "items": {
94651 "format": "uuid4",
10466n/a "type": "string"
113065 },
123110 "type": "array"
133065 },
140311 {
150311 "type": "null"
160311 }
173065 ],
183065}
customer_id4 / 7
13352{
23352 "anyOf": [
30337 {
400 "format": "uuid4",
50n/a "type": "string"
60337 },
73352 {
83352 "items": {
976718 "format": "uuid4",
10785n/a "type": "string"
113352 },
123370 "type": "array"
133352 },
140337 {
150337 "type": "null"
160337 }
173352 ],
183352}
checkout_id4 / 7
16165{
26165 "anyOf": [
30621 {
400 "format": "uuid4",
50n/a "type": "string"
60621 },
76165 {
86165 "items": {
979978 "format": "uuid4",
10877n/a "type": "string"
116165 },
126210 "type": "array"
136165 },
140621 {
150621 "type": "null"
160621 }
176165 ],
186165}
page2 / 2
139819{
23982 "exclusiveMinimum": 0,
340017 "type": "integer"
439819}
limit2 / 2
134622{
23463 "exclusiveMinimum": 0,
334919 "type": "integer"
434622}
sorting4 / 6
115822{
215822 "anyOf": [
315822 {
415822 "items": {
615822 },
71800 "type": "array"
815822 },
90180 {
100180 "type": "null"
110180 }
1215822 ],
1315822}
Referenced Components (1)3 of 3 keywords
OrderSortProperty3 of 3 keywords
159348{
259348 "enum": [
334n/a "created_at",
468n/a "-created_at",
540n/a "status",
615n/a "-status",
766n/a "invoice_number",
842n/a "-invoice_number",
949n/a "amount",
1026n/a "-amount",
1114n/a "net_amount",
1224n/a "-net_amount",
1323n/a "customer",
1424n/a "-customer",
1528n/a "product",
1619n/a "-product",
1739n/a "discount",
1819n/a "-discount",
1932n/a "subscription",
2031n/a "-subscription"
2159348 ],
22630n/a "type": "string"
2359348}
metadata4 / 13
MetadataQuery
12010{
22010 "anyOf": [
32010 {
42010 "additionalProperties": {
55560 "anyOf": [
6402154 {
7402154 "type": "string"
8402154 },
90556 {
100556 "type": "integer"
110556 },
120556 {
130556 "type": "boolean"
140556 },
15154402 {
161540 "items": {
179240 "type": "string"
181540 },
19154402 "type": "array"
20154402 },
210556 {
220154 "items": {
230924 "type": "integer"
240154 },
25154402 "type": "array"
260556 },
270556 {
280154 "items": {
290924 "type": "boolean"
300154 },
31154402 "type": "array"
320556 }
335560 ]
342010 },
352010 "type": "object"
362010 },
370201 {
380201 "type": "null"
390201 }
402010 ],
412010}
Responses
codedescriptionhitsavg
200Successful Response45812ms
422Validation Error629ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1813ms
500Internal Server Error101659ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-created_at" ]sorting
Query Parameters
organization_id2 / 7
#validinvalidschema
14910{
24910 "anyOf": [
30491 {
400 "format": "uuid4",
50n/a "type": "string",
60491 },
74910 {
84910 "items": {
94910 "format": "uuid4",
10491n/a "type": "string",
114910 },
124910 "type": "array"
134910 },
140491 {
150491 "type": "null"
160491 }
174910 ],
184910}
product_id4 / 7
136094{
236094 "anyOf": [
30454 {
400 "format": "uuid4",
50n/a "type": "string",
60454 },
736094 {
836094 "items": {
9381434 "format": "uuid4",
10815n/a "type": "string",
1136094 },
124540 "type": "array"
1336094 },
140454 {
150454 "type": "null"
160454 }
1736094 ],
1836094}
Responses
codedescriptionhitsavg
200Successful Response2396ms
422Validation Error946ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1583ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
Path Parameters
id2 / 2
#validinvalidschema
134474{
234474 "format": "uuid4",
3418n/a "type": "string"
434474}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Order not found.3098ms
422Validation Error746ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized352ms
Path Parameters
id2 / 2
#validinvalidschema
168730{
268730 "format": "uuid4",
3717n/a "type": "string"
468730}
Body
application/json29 / 29
OrderUpdate
152863{
254145 "properties": {
354441 "billing_address": {
454441 "anyOf": [
5342243 {
7342243 },
8202383 {
9202383 "type": "null"
10202383 }
1154441 ],
1254441 },
135677 "billing_name": {
145677 "anyOf": [
15218356 {
16218356 "type": "string"
17218356 },
18349225 {
19349225 "type": "null"
20349225 }
215677 ],
225677 }
2354145 },
2457313 "required": [
2557412 "billing_name",
265851 "billing_address"
2757313 ],
285865 "type": "object"
2952863}
Referenced Components (1)28 of 28 keywords
AddressInput28 of 28 keywords
1342243{
234335 "properties": {
33205 "city": {
43205 "anyOf": [
517308 {
617308 "type": "string"
717308 },
830322 {
930322 "type": "null"
1030322 }
113205 ],
123205 },
133716 "country": {
143716 "enum": [
1530n/a "AD",
163n/a "AE",
171n/a "AF",
181n/a "AG",
191n/a "AI",
201n/a "AL",
211n/a "AM",
221n/a "AO",
231n/a "AQ",
241n/a "AR",
253n/a "AS",
261n/a "AT",
271n/a "AU",
281n/a "AW",
292n/a "AX",
302n/a "AZ",
311n/a "BA",
321n/a "BB",
331n/a "BD",
341n/a "BE",
353n/a "BF",
361n/a "BG",
371n/a "BH",
383n/a "BI",
391n/a "BJ",
401n/a "BL",
411n/a "BM",
421n/a "BN",
431n/a "BO",
441n/a "BQ",
451n/a "BR",
461n/a "BS",
471n/a "BT",
481n/a "BV",
491n/a "BW",
501n/a "BY",
511n/a "BZ",
521n/a "CA",
531n/a "CC",
541n/a "CD",
555n/a "CF",
561n/a "CG",
571n/a "CH",
581n/a "CI",
591n/a "CK",
601n/a "CL",
611n/a "CM",
621n/a "CN",
631n/a "CO",
641n/a "CR",
651n/a "CV",
663n/a "CW",
671n/a "CX",
681n/a "CY",
691n/a "CZ",
701n/a "DE",
715n/a "DJ",
721n/a "DK",
731n/a "DM",
744n/a "DO",
751n/a "DZ",
761n/a "EC",
771n/a "EE",
781n/a "EG",
793n/a "EH",
801n/a "ER",
811n/a "ES",
821n/a "ET",
831n/a "FI",
841n/a "FJ",
852n/a "FK",
861n/a "FM",
872n/a "FO",
882n/a "FR",
891n/a "GA",
901n/a "GB",
912n/a "GD",
923n/a "GE",
931n/a "GF",
941n/a "GG",
951n/a "GH",
961n/a "GI",
971n/a "GL",
981n/a "GM",
991n/a "GN",
1001n/a "GP",
1011n/a "GQ",
1021n/a "GR",
1031n/a "GS",
1042n/a "GT",
1051n/a "GU",
1061n/a "GW",
1071n/a "GY",
1081n/a "HK",
1091n/a "HM",
1101n/a "HN",
1111n/a "HR",
1121n/a "HT",
1132n/a "HU",
1141n/a "ID",
1151n/a "IE",
1161n/a "IL",
1171n/a "IM",
1181n/a "IN",
1191n/a "IO",
1202n/a "IQ",
1211n/a "IS",
1223n/a "IT",
1231n/a "JE",
1241n/a "JM",
1251n/a "JO",
1261n/a "JP",
1271n/a "KE",
1281n/a "KG",
1291n/a "KH",
1301n/a "KI",
1311n/a "KM",
1321n/a "KN",
1331n/a "KR",
1341n/a "KW",
1351n/a "KY",
1361n/a "KZ",
1371n/a "LA",
1381n/a "LB",
1391n/a "LC",
1401n/a "LI",
1411n/a "LK",
1421n/a "LR",
1431n/a "LS",
1441n/a "LT",
1456n/a "LU",
1461n/a "LV",
1471n/a "LY",
1481n/a "MA",
1491n/a "MC",
1501n/a "MD",
1511n/a "ME",
1521n/a "MF",
1531n/a "MG",
1541n/a "MH",
1551n/a "MK",
1561n/a "ML",
1571n/a "MM",
1581n/a "MN",
1591n/a "MO",
1601n/a "MP",
1611n/a "MQ",
1621n/a "MR",
1631n/a "MS",
1641n/a "MT",
1651n/a "MU",
1661n/a "MV",
1671n/a "MW",
1681n/a "MX",
1691n/a "MY",
1701n/a "MZ",
1711n/a "NA",
1721n/a "NC",
1731n/a "NE",
1741n/a "NF",
1751n/a "NG",
1761n/a "NI",
1771n/a "NL",
1786n/a "NO",
1791n/a "NP",
1803n/a "NR",
1811n/a "NU",
1821n/a "NZ",
1831n/a "OM",
1841n/a "PA",
1851n/a "PE",
1861n/a "PF",
1871n/a "PG",
1881n/a "PH",
1891n/a "PK",
1901n/a "PL",
1911n/a "PM",
1921n/a "PN",
1931n/a "PR",
1941n/a "PS",
1951n/a "PT",
1962n/a "PW",
1971n/a "PY",
1981n/a "QA",
1991n/a "RE",
2001n/a "RO",
2011n/a "RS",
2021n/a "RW",
2031n/a "SA",
2041n/a "SB",
2051n/a "SC",
2061n/a "SD",
2072n/a "SE",
2081n/a "SG",
2091n/a "SH",
2101n/a "SI",
2113n/a "SJ",
2121n/a "SK",
2132n/a "SL",
2141n/a "SM",
2151n/a "SN",
2161n/a "SO",
2171n/a "SR",
2181n/a "SS",
2191n/a "ST",
2201n/a "SV",
2211n/a "SX",
2221n/a "SZ",
2231n/a "TC",
2241n/a "TD",
2251n/a "TF",
2262n/a "TG",
2271n/a "TH",
2281n/a "TJ",
2291n/a "TK",
2301n/a "TL",
2311n/a "TM",
2321n/a "TN",
2332n/a "TO",
2343n/a "TR",
2351n/a "TT",
2361n/a "TV",
2371n/a "TW",
2381n/a "TZ",
2391n/a "UA",
2401n/a "UG",
2411n/a "UM",
24237n/a "US",
2431n/a "UY",
2441n/a "UZ",
2451n/a "VA",
2461n/a "VC",
2472n/a "VE",
2484n/a "VG",
2491n/a "VI",
2501n/a "VN",
2511n/a "VU",
2521n/a "WF",
2531n/a "WS",
2541n/a "YE",
2551n/a "YT",
2562n/a "ZA",
2571n/a "ZM",
2581n/a "ZW"
2593716 ],
2603725 "type": "string",
2613716 },
2623137 "line1": {
2633137 "anyOf": [
26423297 {
26523297 "type": "string"
26623297 },
26729030 {
26829030 "type": "null"
26929030 }
2703137 ],
2713137 },
2723126 "line2": {
2733126 "anyOf": [
27419299 {
27519299 "type": "string"
27619299 },
27729325 {
27829325 "type": "null"
27929325 }
2803126 ],
2813126 },
2823194 "postal_code": {
2833194 "anyOf": [
28421302 {
28521302 "type": "string"
28621302 },
28729825 {
28829825 "type": "null"
28929825 }
2903194 ],
2913194 },
29230611 "state": {
29330611 "anyOf": [
29417300 {
29517300 "type": "string"
29617300 },
29728928 {
29828928 "type": "null"
29928928 }
30030611 ],
30130611 }
30234335 },
3033772 "required": [
3043772 "country"
3053772 ],
306379206 "type": "object"
307342243}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Order not found.4907ms
422Validation Error1457ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error5794ms
400Bad Request615ms
401Unauthorized162ms
Examples
Body: application/json
"US"AddressInput.country.examples[0]
"SE"AddressInput.country.examples[1]
"FR"AddressInput.country.examples[2]
Path Parameters
id2 / 2
#validinvalidschema
136841{
236841 "format": "uuid4",
3409n/a "type": "string"
436841}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Order not found.3398ms
422Validation Error416ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized292ms
Path Parameters
id2 / 2
#validinvalidschema
135865{
235865 "format": "uuid4",
3423n/a "type": "string"
435865}
Responses
codedescriptionhitsavg
202Successful Response0never seen
422Order is not paid or is missing billing name or address.656ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3217ms
401Unauthorized372ms
organization_access_token 4 operations 1 covered 3 partial 0 uncovered 0 not measured 78% #
Query Parameters
organization_id2 / 7
#validinvalidschema
16660{
26660 "anyOf": [
30666 {
400 "format": "uuid4",
50n/a "type": "string",
60666 },
76660 {
86660 "items": {
96660 "format": "uuid4",
10666n/a "type": "string",
116660 },
126660 "type": "array"
136660 },
140666 {
150666 "type": "null"
160666 }
176660 ],
186660}
page2 / 2
1286112{
228638 "exclusiveMinimum": 0,
332474 "type": "integer"
4286112}
limit2 / 2
1223153{
222333 "exclusiveMinimum": 0,
3256120 "type": "integer"
4223153}
sorting4 / 6
1145159{
2145159 "anyOf": [
3145159 {
4145159 "items": {
6145159 },
73040 "type": "array"
8145159 },
90304 {
100304 "type": "null"
110304 }
12145159 ],
13145159}
Referenced Components (1)3 of 3 keywords
OrganizationAccessTokenSortProperty3 of 3 keywords
1563535{
2563535 "enum": [
391n/a "created_at",
457n/a "-created_at",
583n/a "comment",
682n/a "-comment",
761n/a "last_used_at",
868n/a "-last_used_at",
964n/a "organization_id",
1057n/a "-organization_id"
11563535 ],
121046n/a "type": "string"
13563535}
Responses
codedescriptionhitsavg
200Successful Response3488ms
422Validation Error2756ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized382ms
500Internal Server Error51730ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "created_at" ]sorting
Body
application/json13 / 14
OrganizationAccessTokenCreate
#validinvalidschema
151057{
251447 "properties": {
35546 "comment": {
45546 "type": "string"
55546 },
621718 "expires_in": {
721718 "anyOf": [
820332 {
92035 "format": "duration",
1020827 "type": "string"
1120332 },
1214221 {
1314221 "type": "null"
1414221 }
1521718 ],
1621718 },
175555 "organization_id": {
185550 "format": "uuid4",
195555 "type": "string"
205555 },
2153722 "scopes": {
2253713 "items": {
2453713 },
255509 "type": "array"
2653722 }
2751447 },
285574 "required": [
295601 "organization_id",
305601 "comment",
315592 "scopes"
325574 ],
335616 "type": "object"
3451057}
Referenced Components (1)3 of 3 keywords
AvailableScope3 of 3 keywords
1116913{
2116913 "enum": [
326n/a "openid",
414n/a "profile",
527n/a "email",
623n/a "user:read",
77n/a "organizations:read",
821n/a "organizations:write",
926n/a "custom_fields:read",
1022n/a "custom_fields:write",
1112n/a "discounts:read",
1210n/a "discounts:write",
1324n/a "checkout_links:read",
1415n/a "checkout_links:write",
1510n/a "checkouts:read",
1618n/a "checkouts:write",
1712n/a "transactions:read",
1816n/a "transactions:write",
1918n/a "payouts:read",
2020n/a "payouts:write",
217n/a "products:read",
2223n/a "products:write",
2328n/a "benefits:read",
2421n/a "benefits:write",
2515n/a "events:read",
2623n/a "events:write",
2727n/a "meters:read",
2814n/a "meters:write",
2925n/a "files:read",
3022n/a "files:write",
3117n/a "subscriptions:read",
3220n/a "subscriptions:write",
339n/a "customers:read",
3436n/a "customers:write",
356n/a "members:read",
3615n/a "members:write",
3718n/a "wallets:read",
3819n/a "wallets:write",
3927n/a "customer_meters:read",
4016n/a "customer_sessions:write",
4126n/a "customer_seats:read",
4224n/a "customer_seats:write",
4324n/a "orders:read",
4414n/a "orders:write",
4518n/a "refunds:read",
4618n/a "refunds:write",
4748n/a "payments:read",
4820n/a "metrics:read",
4921n/a "webhooks:read",
509n/a "webhooks:write",
5129n/a "external_organizations:read",
5220n/a "license_keys:read",
5311n/a "license_keys:write",
5416n/a "repositories:read",
5518n/a "repositories:write",
5622n/a "issues:read",
5719n/a "issues:write",
5823n/a "customer_portal:read",
5912n/a "customer_portal:write",
6014n/a "notifications:read",
6131n/a "notifications:write",
625n/a "notification_recipients:read",
6318n/a "notification_recipients:write"
64116913 ],
6511775 "type": "string"
66116913}
Responses
codedescriptionhitsavg
201Successful Response47213ms
422Validation Error786ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized403ms
400Bad Request116ms
500Internal Server Error21756ms
Path Parameters
id1 / 2
#validinvalidschema
1290{
2290 "format": "uuid4",
329n/a "type": "string"
4290}
Responses
codedescriptionhitsavg
204Successful Response1912ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized33ms
404Not Found76ms
Path Parameters
id2 / 2
#validinvalidschema
14334{
24334 "format": "uuid4",
3437n/a "type": "string"
44334}
Body
application/json11 / 11
OrganizationAccessTokenUpdate
137835{
210529 "properties": {
311211 "comment": {
411211 "anyOf": [
54776 {
64776 "type": "string"
74776 },
86558 {
96558 "type": "null"
106558 }
1111211 ],
1211211 },
138923 "scopes": {
148923 "anyOf": [
156844 {
166815 "items": {
186815 },
198329 "type": "array"
206844 },
212191 {
222191 "type": "null"
232191 }
248923 ],
258923 }
2610529 },
274076 "type": "object"
2837835}
Referenced Components (1)3 of 3 keywords
AvailableScope3 of 3 keywords
116055{
216055 "enum": [
32n/a "openid",
41n/a "profile",
52n/a "email",
60n/a "user:read",
70n/a "organizations:read",
81n/a "organizations:write",
91n/a "custom_fields:read",
101n/a "custom_fields:write",
113n/a "discounts:read",
123n/a "discounts:write",
133n/a "checkout_links:read",
141n/a "checkout_links:write",
151n/a "checkouts:read",
161n/a "checkouts:write",
177n/a "transactions:read",
180n/a "transactions:write",
194n/a "payouts:read",
200n/a "payouts:write",
212n/a "products:read",
222n/a "products:write",
231n/a "benefits:read",
240n/a "benefits:write",
252n/a "events:read",
262n/a "events:write",
276n/a "meters:read",
282n/a "meters:write",
292n/a "files:read",
305n/a "files:write",
311n/a "subscriptions:read",
327n/a "subscriptions:write",
332n/a "customers:read",
342n/a "customers:write",
352n/a "members:read",
364n/a "members:write",
372n/a "wallets:read",
382n/a "wallets:write",
392n/a "customer_meters:read",
402n/a "customer_sessions:write",
413n/a "customer_seats:read",
429n/a "customer_seats:write",
432n/a "orders:read",
446n/a "orders:write",
451n/a "refunds:read",
462n/a "refunds:write",
475n/a "payments:read",
482n/a "metrics:read",
493n/a "webhooks:read",
503n/a "webhooks:write",
512n/a "external_organizations:read",
523n/a "license_keys:read",
532n/a "license_keys:write",
546n/a "repositories:read",
552n/a "repositories:write",
561n/a "issues:read",
576n/a "issues:write",
584n/a "customer_portal:read",
596n/a "customer_portal:write",
603n/a "notifications:read",
611n/a "notifications:write",
623n/a "notification_recipients:read",
634n/a "notification_recipients:write"
6416055 ],
6516253 "type": "string"
6616055}
Responses
codedescriptionhitsavg
200Successful Response3017ms
422Validation Error536ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error441666ms
401Unauthorized133ms
400Bad Request95ms
404Not Found177ms
organizations 12 operations 1 covered 10 partial 1 uncovered 0 not measured 89% #
Query Parameters
slug3 / 3
#validinvalidschema
1177n/a{
2177n/a "anyOf": [
3162n/a {
4162n/a "type": "string"
5162n/a },
615162 {
715162 "type": "null"
815162 }
9177n/a ],
10177n/a}
page2 / 2
117393{
217328 "exclusiveMinimum": 0,
320165 "type": "integer"
417393}
limit2 / 2
1173106{
217370 "exclusiveMinimum": 0,
324336 "type": "integer"
4173106}
sorting4 / 6
189117{
289117 "anyOf": [
389117 {
489117 "items": {
689117 },
72060 "type": "array"
889117 },
90206 {
100206 "type": "null"
110206 }
1289117 ],
1389117}
Referenced Components (1)3 of 3 keywords
OrganizationSortProperty3 of 3 keywords
1365500{
2365500 "enum": [
343n/a "created_at",
448n/a "-created_at",
534n/a "slug",
634n/a "-slug",
724n/a "name",
838n/a "-name",
926n/a "next_review_threshold",
1030n/a "-next_review_threshold",
1141n/a "days_in_status",
1247n/a "-days_in_status"
13365500 ],
14728n/a "type": "string"
15365500}
Responses
codedescriptionhitsavg
200Successful Response2767ms
422Validation Error2228ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized552ms
500Internal Server Error31380ms
Examples
Query
1page
10limit
[ "created_at" ]sorting
Body
application/json89 / 102
OrganizationCreate
#validinvalidschema
1425241{
2428232 "properties": {
33662 "avatar_url": {
43662 "anyOf": [
534028 {
63401 "format": "uri",
73410 "maxLength": 2083,
83410 "minLength": 1,
934127 "type": "string"
1034028 },
1126342 {
1226342 "type": "null"
1326342 }
143662 ],
153662 },
1627356 "customer_email_settings": {
1727356 "anyOf": [
1854275 {
2054275 },
21219110 {
22219110 "type": "null"
23219110 }
2427356 ]
2527356 },
2630562 "details": {
2730562 "anyOf": [
2878289 {
3078289 },
31227140 {
32227140 "type": "null"
33227140 }
3430562 ],
3530562 },
363350 "email": {
373350 "anyOf": [
3830530 {
393350 "format": "email",
4030530 "type": "string"
4130530 },
4230305 {
4330305 "type": "null"
4430305 }
453350 ],
463350 },
4728730 "feature_settings": {
4828730 "anyOf": [
4948269 {
5148269 },
5223978 {
5323978 "type": "null"
5423978 }
5528730 ]
5628730 },
5764612 "name": {
5864612 "minLength": 3,
596580 "type": "string"
6064612 },
6134618 "notification_settings": {
6234618 "anyOf": [
63101263 {
65101263 },
66245119 {
67245119 "type": "null"
68245119 }
6934618 ]
7034618 },
716545 "slug": {
726545 "minLength": 3,
736590 "type": "string"
746545 },
7532913 "socials": {
7632913 "anyOf": [
7728656 {
782869 "items": {
802869 },
8129547 "type": "array"
8228656 },
8343299 {
8443299 "type": "null"
8543299 }
8632913 ],
8732913 },
8828639 "subscription_settings": {
8928639 "anyOf": [
9048277 {
9248277 },
9323887 {
9423887 "type": "null"
9523887 }
9628639 ]
9728639 },
983271 "website": {
993271 "anyOf": [
10030523 {
1013051 "format": "uri",
1023051 "maxLength": 2083,
1033060 "minLength": 1,
10430622 "type": "string"
10530523 },
10622306 {
10722306 "type": "null"
10822306 }
1093271 ],
1103271 }
111428232 },
1126573 "required": [
1136582 "name",
1146591 "slug"
1156573 ],
1166606 "type": "object"
117425241}
Referenced Components (8)68 of 75 keywords
OrganizationCustomerEmailSettings13 of 13 keywords
154275{
26243 "properties": {
3995 "order_confirmation": {
4995 "type": "boolean"
5995 },
6995 "subscription_cancellation": {
7995 "type": "boolean"
8995 },
9995 "subscription_confirmation": {
10995 "type": "boolean"
11995 },
12995 "subscription_cycled": {
13995 "type": "boolean"
14995 },
15995 "subscription_past_due": {
16995 "type": "boolean"
17995 },
18995 "subscription_revoked": {
19995 "type": "boolean"
20995 },
21995 "subscription_uncanceled": {
22995 "type": "boolean"
23995 },
24968 "subscription_updated": {
25968 "type": "boolean"
26968 }
276243 },
28979 "required": [
291042 "order_confirmation",
301042 "subscription_cancellation",
311042 "subscription_confirmation",
321042 "subscription_cycled",
331042 "subscription_past_due",
341042 "subscription_revoked",
351042 "subscription_uncanceled",
361042 "subscription_updated"
37979 ],
38106223 "type": "object"
3954275}
OrganizationDetails21 of 21 keywords
178289{
28351 "properties": {
31285 "about": {
41285 "type": "string"
51285 },
612310 "customer_acquisition": {
71235 "items": {
83515 "type": "string"
91235 },
101285 "type": "array"
1112310 },
121258 "future_annual_revenue": {
131262 "minimum": 0.0,
141276 "type": "integer"
151258 },
161276 "intended_use": {
171276 "type": "string"
181276 },
19947 "previous_annual_revenue": {
20951 "minimum": 0.0,
21956 "type": "integer"
22947 },
231285 "product_description": {
241285 "type": "string"
251285 },
26915 "switching": {
27915 "type": "boolean"
28915 },
29946 "switching_from": {
30946 "anyOf": [
313466 {
323466 "enum": [
334n/a "paddle",
347n/a "lemon_squeezy",
3516n/a "gumroad",
363n/a "stripe",
374n/a "other"
383466 ],
393565 "type": "string"
403466 },
416040 {
426040 "type": "null"
436040 }
44946 ],
45946 }
468351 },
471297 "required": [
481333 "about",
491333 "product_description",
501333 "intended_use",
511333 "customer_acquisition",
521333 "future_annual_revenue"
531297 ],
54136231 "type": "object"
5578289}
OrganizationFeatureSettings8 of 8 keywords
148269{
24126 "properties": {
3486 "issue_funding_enabled": {
4486 "type": "boolean"
5486 },
6535 "member_model_enabled": {
7535 "type": "boolean"
8535 },
9545 "revops_enabled": {
10545 "type": "boolean"
11545 },
12575 "seat_based_pricing_enabled": {
13575 "type": "boolean"
14575 },
15525 "wallets_enabled": {
16525 "type": "boolean"
17525 }
184126 },
1974243 "type": "object"
2048269}
OrganizationNotificationSettings7 of 7 keywords
1101263{
210310 "properties": {
31075 "new_order": {
41075 "type": "boolean"
51075 },
61075 "new_subscription": {
71075 "type": "boolean"
81075 }
910310 },
101113 "required": [
111122 "new_order",
121122 "new_subscription"
131113 ],
14114250 "type": "object"
15101263}
OrganizationSocialPlatforms0 of 3 keywords
13390{
23390 "enum": [
357n/a "x",
446n/a "github",
532n/a "facebook",
633n/a "instagram",
743n/a "youtube",
839n/a "tiktok",
931n/a "linkedin",
1058n/a "other"
113390 ],
123390 "type": "string"
133390}
OrganizationSubscriptionSettings10 of 10 keywords
148277{
25328 "properties": {
3755 "allow_customer_updates": {
4755 "type": "boolean"
5755 },
6755 "allow_multiple_subscriptions": {
7755 "type": "boolean"
8755 },
9746 "benefit_revocation_grace_period": {
10746 "type": "integer"
11746 },
12746 "prevent_trial_abuse": {
13746 "type": "boolean"
14746 },
15746 "proration_behavior": {
17746 }
185328 },
19766 "required": [
20802 "allow_multiple_subscriptions",
21802 "allow_customer_updates",
22802 "proration_behavior",
23802 "benefit_revocation_grace_period",
24802 "prevent_trial_abuse"
25766 ],
2682243 "type": "object"
2748277}
SubscriptionProrationBehavior3 of 3 keywords
1746{
2746 "enum": [
353n/a "invoice",
421n/a "prorate"
5746 ],
6755 "type": "string"
7746}
Responses
codedescriptionhitsavg
201Organization created.1521ms
422Validation Error6616ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized282ms
500Internal Server Error7813ms
400Bad Request365ms
Examples
Body: application/json
0OrganizationDetails.previous_annual_revenue
trueOrganizationDetails.switching
falseOrganizationFeatureSettings.issue_funding_enabled
falseOrganizationFeatureSettings.member_model_enabled
falseOrganizationFeatureSettings.revops_enabled
falseOrganizationFeatureSettings.seat_based_pricing_enabled
falseOrganizationFeatureSettings.wallets_enabled
Path Parameters
idno coverage data
#validinvalidschema
100{
200 "format": "uuid4",
30n/a "type": "string",
400}
Expected Responses
codedescriptionhitsavg
200Organization deleted or deletion request submitted.0never seen
403You don't have the permission to delete this organization.0never seen
404Organization not found.0never seen
422Validation Error0never seen
Path Parameters
id1 / 2
#validinvalidschema
14650{
24650 "format": "uuid4",
3465n/a "type": "string",
44650}
Responses
codedescriptionhitsavg
200Successful Response637ms
404Organization not found.0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4022ms
Examples
Path
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"id
Path Parameters
id2 / 2
#validinvalidschema
17051{
27051 "format": "uuid4",
3706n/a "type": "string",
47051}
Body
application/json101 / 101
OrganizationUpdate
1402272{
2176264 "properties": {
33849 "avatar_url": {
43849 "anyOf": [
537122 {
63723 "format": "uri",
73741 "maxLength": 2083,
83741 "minLength": 1,
937518 "type": "string"
1037122 },
1113380 {
1213380 "type": "null"
1313380 }
143849 ],
153849 },
1632359 "customer_email_settings": {
1732359 "anyOf": [
1831351 {
2031351 },
2129290 {
2229290 "type": "null"
2329290 }
2432359 ]
2532359 },
2631963 "details": {
2731963 "anyOf": [
2842340 {
3042340 },
31277105 {
32277105 "type": "null"
33277105 }
3431963 ],
3531963 },
363627 "email": {
373627 "anyOf": [
3834722 {
393672 "format": "email",
4034920 "type": "string"
4134722 },
4215354 {
4315354 "type": "null"
4415354 }
453627 ],
463627 },
4734530 "feature_settings": {
4834530 "anyOf": [
4947328 {
5147328 },
5229877 {
5329877 "type": "null"
5429877 }
5534530 ]
5634530 },
573776 "name": {
583776 "anyOf": [
5936518 {
603651 "minLength": 3,
6136617 "type": "string"
6236518 },
6312371 {
6412371 "type": "null"
6512371 }
663776 ],
673776 },
6835723 "notification_settings": {
6935723 "anyOf": [
7020360 {
7220360 },
7333743 {
7433743 "type": "null"
7533743 }
7635723 ]
7735723 },
7834030 "socials": {
7934030 "anyOf": [
8031654 {
8131624 "items": {
8331624 },
8434030 "type": "array"
8531654 },
8624346 {
8724346 "type": "null"
8824346 }
8934030 ],
9034030 },
9133338 "subscription_settings": {
9233338 "anyOf": [
9327344 {
9527344 },
9630665 {
9730665 "type": "null"
9830665 }
9933338 ]
10033338 },
1013679 "website": {
1023679 "anyOf": [
10335224 {
1043533 "format": "uri",
1053551 "maxLength": 2083,
1063551 "minLength": 1,
10735620 "type": "string"
10835224 },
10915361 {
11015361 "type": "null"
11115361 }
1123679 ],
1133679 }
114176264 },
1156668 "type": "object"
116402272}
Referenced Components (8)75 of 75 keywords
OrganizationCustomerEmailSettings13 of 13 keywords
131351{
23943 "properties": {
3765 "order_confirmation": {
4765 "type": "boolean"
5765 },
6756 "subscription_cancellation": {
7756 "type": "boolean"
8756 },
9765 "subscription_confirmation": {
10765 "type": "boolean"
11765 },
12756 "subscription_cycled": {
13756 "type": "boolean"
14756 },
15765 "subscription_past_due": {
16765 "type": "boolean"
17765 },
18765 "subscription_revoked": {
19765 "type": "boolean"
20765 },
21756 "subscription_uncanceled": {
22756 "type": "boolean"
23756 },
24765 "subscription_updated": {
25765 "type": "boolean"
26765 }
273943 },
28749 "required": [
29812 "order_confirmation",
30812 "subscription_cancellation",
31812 "subscription_confirmation",
32812 "subscription_cycled",
33812 "subscription_past_due",
34812 "subscription_revoked",
35812 "subscription_uncanceled",
36812 "subscription_updated"
37749 ],
3883299 "type": "object"
3931351}
OrganizationDetails21 of 21 keywords
142340{
24753 "properties": {
3945 "about": {
4945 "type": "string"
5945 },
68910 "customer_acquisition": {
7895 "items": {
81755 "type": "string"
9895 },
10945 "type": "array"
118910 },
12927 "future_annual_revenue": {
13931 "minimum": 0.0,
14936 "type": "integer"
15927 },
16945 "intended_use": {
17945 "type": "string"
18945 },
19809 "previous_annual_revenue": {
20813 "minimum": 0.0,
21836 "type": "integer"
22809 },
23945 "product_description": {
24945 "type": "string"
25945 },
26815 "switching": {
27815 "type": "boolean"
28815 },
29817 "switching_from": {
30817 "anyOf": [
312464 {
322464 "enum": [
333n/a "paddle",
3411n/a "lemon_squeezy",
352n/a "gumroad",
364n/a "stripe",
374n/a "other"
382464 ],
392761 "type": "string"
402464 },
415731 {
425731 "type": "null"
435731 }
44817 ],
45817 }
464753 },
47956 "required": [
48992 "about",
49992 "product_description",
50992 "intended_use",
51992 "customer_acquisition",
52992 "future_annual_revenue"
53956 ],
54101281 "type": "object"
5542340}
OrganizationFeatureSettings8 of 8 keywords
147328{
24026 "properties": {
3435 "issue_funding_enabled": {
4435 "type": "boolean"
5435 },
6475 "member_model_enabled": {
7475 "type": "boolean"
8475 },
9466 "revops_enabled": {
10466 "type": "boolean"
11466 },
12415 "seat_based_pricing_enabled": {
13415 "type": "boolean"
14415 },
15455 "wallets_enabled": {
16455 "type": "boolean"
17455 }
184026 },
1973302 "type": "object"
2047328}
OrganizationNotificationSettings7 of 7 keywords
120360{
22213 "properties": {
3268 "new_order": {
4268 "type": "boolean"
5268 },
6265 "new_subscription": {
7265 "type": "boolean"
8265 }
92213 },
10306 "required": [
11342 "new_order",
12315 "new_subscription"
13306 ],
1436344 "type": "object"
1520360}
OrganizationSocialPlatforms3 of 3 keywords
11666{
21666 "enum": [
330n/a "x",
425n/a "github",
524n/a "facebook",
627n/a "instagram",
711n/a "youtube",
819n/a "tiktok",
920n/a "linkedin",
1010n/a "other"
111666 ],
121675 "type": "string"
131666}
OrganizationSubscriptionSettings10 of 10 keywords
127344{
23228 "properties": {
3545 "allow_customer_updates": {
4545 "type": "boolean"
5545 },
6545 "allow_multiple_subscriptions": {
7545 "type": "boolean"
8545 },
9527 "benefit_revocation_grace_period": {
10527 "type": "integer"
11527 },
12545 "prevent_trial_abuse": {
13545 "type": "boolean"
14545 },
15536 "proration_behavior": {
17536 }
183228 },
19556 "required": [
20592 "allow_multiple_subscriptions",
21592 "allow_customer_updates",
22592 "proration_behavior",
23592 "benefit_revocation_grace_period",
24592 "prevent_trial_abuse"
25556 ],
2661310 "type": "object"
2727344}
SubscriptionProrationBehavior3 of 3 keywords
1536{
2536 "enum": [
344n/a "invoice",
49n/a "prorate"
5536 ],
6545 "type": "string"
7536}
Responses
codedescriptionhitsavg
200Organization updated.23613ms
403You don't have the permission to update this organization.0never seen
404Organization not found.248ms
422Validation Error3975ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error27924ms
401Unauthorized162ms
400Bad Request65ms
Examples
Body: application/json
0OrganizationDetails.previous_annual_revenue
trueOrganizationDetails.switching
falseOrganizationFeatureSettings.issue_funding_enabled
falseOrganizationFeatureSettings.member_model_enabled
falseOrganizationFeatureSettings.revops_enabled
falseOrganizationFeatureSettings.seat_based_pricing_enabled
falseOrganizationFeatureSettings.wallets_enabled
Path
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"id
Path Parameters
id1 / 2
#validinvalidschema
14700{
24700 "format": "uuid4",
3470n/a "type": "string",
44700}
Responses
codedescriptionhitsavg
200Successful Response0never seen
403User is not the admin of the account.0never seen
404Organization not found or account not set.707ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4002ms
Examples
Path
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"id
Path Parameters
id1 / 2
#validinvalidschema
1970{
2970 "format": "uuid4",
397n/a "type": "string",
4970}
Responses
codedescriptionhitsavg
200Organization validated with AI.14148ms
404Organization not found.169ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error63866ms
401Unauthorized47ms
Examples
Path
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"id
Path Parameters
id1 / 2
#validinvalidschema
14780{
24780 "format": "uuid4",
3478n/a "type": "string",
44780}
Body
application/json6 / 6
OrganizationAppealRequest
141736{
241723 "properties": {
341723 "reason": {
44277 "maxLength": 5000,
542410 "minLength": 50,
64346 "type": "string"
741723 }
841723 },
94407 "required": [
104407 "reason"
114407 ],
124476 "type": "object"
1341736}
Responses
codedescriptionhitsavg
200Appeal submitted successfully.520ms
400Invalid appeal request.105ms
404Organization not found.156ms
422Validation Error3997ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized492ms
Examples
Path
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"id
Path Parameters
id1 / 2
#validinvalidschema
14860{
24860 "format": "uuid4",
3486n/a "type": "string",
44860}
Responses
codedescriptionhitsavg
200Successful Response4017ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized482ms
404Not Found377ms
Examples
Path
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"id
Path Parameters
id1 / 2
#validinvalidschema
13810{
23810 "format": "uuid4",
3381n/a "type": "string",
43810}
Body
application/json5 / 5
OrganizationMemberInvite
132235{
232224 "properties": {
332224 "email": {
433016 "format": "email",
53388 "type": "string"
632224 }
732224 },
83465 "required": [
93465 "email"
103465 ],
113516 "type": "object"
1232235}
Responses
codedescriptionhitsavg
200Successful Response2248ms
422Validation Error606ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found136ms
201Created62119ms
401Unauthorized203ms
400Bad Request25ms
Examples
Path
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"id
Path Parameters
id1 / 2
#validinvalidschema
14830{
24830 "format": "uuid4",
3483n/a "type": "string",
44830}
Query Parameters
account_verification_only1 / 1
175303{
275303 "type": "boolean"
375303}
Responses
codedescriptionhitsavg
200Successful Response928ms
404Organization not found.0never seen
422Validation Error3037ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized887ms
Examples
Path
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"id
Query
falseaccount_verification_only
Path Parameters
id1 / 2
#validinvalidschema
14590{
24590 "format": "uuid4",
3459n/a "type": "string",
44590}
Responses
codedescriptionhitsavg
200Organization review status retrieved.587ms
404Organization not found.0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4012ms
Examples
Path
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"id
payments 2 operations 1 covered 1 partial 0 uncovered 0 not measured 50% #
Query Parameters
organization_id2 / 7
#validinvalidschema
15110{
25110 "anyOf": [
30511 {
400 "format": "uuid4",
50n/a "type": "string",
60511 },
75110 {
85110 "items": {
95110 "format": "uuid4",
10511n/a "type": "string",
115110 },
125110 "type": "array"
135110 },
140511 {
150511 "type": "null"
160511 }
175110 ],
185110}
checkout_id4 / 7
14176{
24176 "anyOf": [
30423 {
400 "format": "uuid4",
50n/a "type": "string"
60423 },
74176 {
84176 "items": {
945412 "format": "uuid4",
10466n/a "type": "string"
114176 },
124230 "type": "array"
134176 },
140423 {
150423 "type": "null"
160423 }
174176 ],
184176}
order_id4 / 7
123224{
223224 "anyOf": [
30256 {
400 "format": "uuid4",
50n/a "type": "string"
60256 },
723224 {
823224 "items": {
94166 "format": "uuid4",
10422n/a "type": "string"
1123224 },
122560 "type": "array"
1323224 },
140256 {
150256 "type": "null"
160256 }
1723224 ],
1823224}
status4 / 7
1108103{
2108103 "anyOf": [
30211 {
50211 },
6108103 {
7108103 "items": {
9108103 },
102110 "type": "array"
11108103 },
120211 {
130211 "type": "null"
140211 }
15108103 ],
16108103}
Referenced Components (1)3 of 3 keywords
PaymentStatus3 of 3 keywords
1244710{
2244710 "enum": [
3113n/a "pending",
468n/a "succeeded",
563n/a "failed"
6244710 ],
7714n/a "type": "string"
8244710}
method3 / 5
1103n/a{
2103n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
6103108 {
7103n/a "items": {
8679n/a "type": "string"
9103n/a },
102110 "type": "array"
11103108 },
120211 {
130211 "type": "null"
140211 }
15103n/a ],
16103n/a}
customer_email3 / 5
1110n/a{
2110n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
6110105 {
7110n/a "items": {
8193n/a "type": "string"
9110n/a },
102150 "type": "array"
11110105 },
120215 {
130215 "type": "null"
140215 }
15110n/a ],
16110n/a}
page2 / 2
128816{
22882 "exclusiveMinimum": 0,
329014 "type": "integer"
428816}
limit2 / 2
128615{
22862 "exclusiveMinimum": 0,
328813 "type": "integer"
428615}
sorting4 / 6
115860{
215860 "anyOf": [
315860 {
415860 "items": {
615860 },
72180 "type": "array"
815860 },
90218 {
100218 "type": "null"
110218 }
1215860 ],
1315860}
Referenced Components (1)3 of 3 keywords
PaymentSortProperty3 of 3 keywords
157162{
257162 "enum": [
357n/a "created_at",
494n/a "-created_at",
538n/a "status",
634n/a "-status",
7192n/a "amount",
849n/a "-amount",
950n/a "method",
1057n/a "-method"
1157162 ],
12573n/a "type": "string"
1357162}
Responses
codedescriptionhitsavg
200Successful Response2768ms
422Validation Error1426ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized893ms
500Internal Server Error41503ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-created_at" ]sorting
Path Parameters
id2 / 2
#validinvalidschema
136076{
236076 "format": "uuid4",
3436n/a "type": "string"
436076}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Payment not found.3227ms
422Validation Error766ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized382ms
payouts 6 operations 5 covered 1 partial 0 uncovered 0 not measured 78% #
Query Parameters
account_id4 / 7
#validinvalidschema
125649{
225649 "anyOf": [
30305 {
400 "format": "uuid4",
50n/a "type": "string"
60305 },
725649 {
825649 "items": {
9160092 "format": "uuid4",
101692n/a "type": "string"
1125649 },
123050 "type": "array"
1325649 },
140305 {
150305 "type": "null"
160305 }
1725649 ],
1825649}
status4 / 7
121949{
221949 "anyOf": [
30268 {
50268 },
621949 {
721949 "items": {
921949 },
102680 "type": "array"
1121949 },
120268 {
130268 "type": "null"
140268 }
1521949 ],
1621949}
Referenced Components (1)3 of 3 keywords
PayoutStatus3 of 3 keywords
1816330{
2816330 "enum": [
3440n/a "pending",
4175n/a "in_transit",
5201n/a "succeeded"
6816330 ],
7842n/a "type": "string"
8816330}
page2 / 2
1259111{
225996 "exclusiveMinimum": 0,
335515 "type": "integer"
4259111}
limit2 / 2
135128{
235113 "exclusiveMinimum": 0,
336415 "type": "integer"
435128}
sorting4 / 6
121738{
221738 "anyOf": [
321738 {
421738 "items": {
621738 },
72550 "type": "array"
821738 },
90255 {
100255 "type": "null"
110255 }
1221738 ],
1321738}
Referenced Components (1)3 of 3 keywords
PayoutSortProperty3 of 3 keywords
1151160{
2151160 "enum": [
345n/a "created_at",
463n/a "-created_at",
5782n/a "amount",
652n/a "-amount",
748n/a "fees_amount",
8170n/a "-fees_amount",
935n/a "status",
1066n/a "-status",
1156n/a "paid_at",
1270n/a "-paid_at",
1376n/a "account_id",
1448n/a "-account_id"
15151160 ],
161546n/a "type": "string"
17151160}
Responses
codedescriptionhitsavg
200Successful Response2908ms
422Validation Error1766ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1482ms
500Internal Server Error61654ms
Examples
Query
1page
10limit
[ "-created_at" ]sorting
Body
application/json5 / 5
PayoutCreate
#validinvalidschema
143366{
243317 "properties": {
343317 "account_id": {
44339 "format": "uuid4",
54428 "type": "string"
643317 }
743317 },
845042 "required": [
945042 "account_id"
1045042 ],
114927 "type": "object"
1243366}
Responses
codedescriptionhitsavg
201Successful Response0never seen
422Validation Error1016ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3937ms
400Bad Request95ms
401Unauthorized402ms
Query Parameters
account_id2 / 2
#validinvalidschema
149633{
249633 "format": "uuid4",
3529n/a "type": "string"
449633}
Responses
codedescriptionhitsavg
200Payout estimate computed successfully.0never seen
400The balance is insufficient to create a payout.0never seen
403The account is under review or not ready.0never seen
404Account not found.4477ms
422Validation Error346ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized492ms
Path Parameters
id2 / 2
#validinvalidschema
134063{
234063 "format": "uuid4",
3403n/a "type": "string"
434063}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error635ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3057ms
401Unauthorized352ms
Path Parameters
id2 / 2
#validinvalidschema
135351{
235351 "format": "uuid4",
3404n/a "type": "string"
435351}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error515ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3246ms
401Unauthorized292ms
Path Parameters
id2 / 2
#validinvalidschema
136456{
236456 "format": "uuid4",
3420n/a "type": "string"
436456}
Body
application/json5 / 5
PayoutGenerateInvoice
134332{
24517 "properties": {
34517 "invoice_number": {
44517 "anyOf": [
52042 {
62042 "type": "string"
72042 },
82537 {
92537 "type": "null"
102537 }
114517 ],
124517 }
134517 },
1436015 "type": "object"
1534332}
Responses
codedescriptionhitsavg
202Successful Response0never seen
422Validation Error905ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3127ms
400Bad Request85ms
401Unauthorized102ms
personal_access_token 2 operations 1 covered 0 partial 1 uncovered 0 not measured 66% #
Query Parameters
page2 / 2
#validinvalidschema
177224{
27743 "exclusiveMinimum": 0,
3120181 "type": "integer"
477224}
limit2 / 2
120279{
220218 "exclusiveMinimum": 0,
322061 "type": "integer"
420279}
Responses
codedescriptionhitsavg
200Successful Response1276ms
422Validation Error2416ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized312ms
500Internal Server Error41329ms
Examples
Query
1page
10limit
Path Parameters
idno coverage data
#validinvalidschema
100{
200 "format": "uuid4",
30n/a "type": "string"
400}
Expected Responses
codedescriptionhitsavg
204Successful Response0never seen
422Validation Error0never seen
products 5 operations 0 covered 5 partial 0 uncovered 0 not measured 89% #
Query Parameters
id4 / 7
#validinvalidschema
15552{
25552 "anyOf": [
30557 {
400 "format": "uuid4",
50n/a "type": "string",
60557 },
75552 {
85552 "items": {
95872 "format": "uuid4",
10589n/a "type": "string",
115552 },
125570 "type": "array"
135552 },
140557 {
150557 "type": "null"
160557 }
175552 ],
185552}
organization_id2 / 7
16390{
26390 "anyOf": [
30639 {
400 "format": "uuid4",
50n/a "type": "string",
60639 },
76390 {
86390 "items": {
96390 "format": "uuid4",
10639n/a "type": "string",
116390 },
126390 "type": "array"
136390 },
140639 {
150639 "type": "null"
160639 }
176390 ],
186390}
query3 / 3
1279n/a{
2279n/a "anyOf": [
3242n/a {
4242n/a "type": "string"
5242n/a },
637242 {
737242 "type": "null"
837242 }
9279n/a ],
10279n/a}
is_archived3 / 3
11886{
21886 "anyOf": [
314549 {
414549 "type": "boolean"
514549 },
643151 {
743151 "type": "null"
843151 }
91886 ],
101886}
is_recurring3 / 3
11677{
21677 "anyOf": [
313440 {
413440 "type": "boolean"
513440 },
633141 {
733141 "type": "null"
833141 }
91677 ],
101677}
benefit_id3 / 7
13061{
23061 "anyOf": [
30307 {
400 "format": "uuid4",
50n/a "type": "string",
60307 },
73061 {
83061 "items": {
96460 "format": "uuid4",
10646n/a "type": "string",
113061 },
123070 "type": "array"
133061 },
140307 {
150307 "type": "null"
160307 }
173061 ],
183061}
page2 / 2
131558{
231547 "exclusiveMinimum": 0,
336211 "type": "integer"
431558}
limit2 / 2
134719{
23472 "exclusiveMinimum": 0,
334917 "type": "integer"
434719}
sorting4 / 6
121038{
221038 "anyOf": [
321038 {
421038 "items": {
621038 },
72480 "type": "array"
821038 },
90248 {
100248 "type": "null"
110248 }
1221038 ],
1321038}
Referenced Components (1)3 of 3 keywords
ProductSortProperty3 of 3 keywords
170240{
270240 "enum": [
362n/a "created_at",
4153n/a "-created_at",
5114n/a "name",
645n/a "-name",
7150n/a "price_amount_type",
856n/a "-price_amount_type",
956n/a "price_amount",
1066n/a "-price_amount"
1170240 ],
12704n/a "type": "string"
1370240}
metadata4 / 13
MetadataQuery
11950{
21950 "anyOf": [
31950 {
41950 "additionalProperties": {
55400 "anyOf": [
6363177 {
7363177 "type": "string"
8363177 },
90540 {
100540 "type": "integer"
110540 },
120540 {
130540 "type": "boolean"
140540 },
15177363 {
161770 "items": {
1714050 "type": "string"
181770 },
19177363 "type": "array"
20177363 },
210540 {
220177 "items": {
2301405 "type": "integer"
240177 },
25177363 "type": "array"
260540 },
270540 {
280177 "items": {
2901405 "type": "boolean"
300177 },
31177363 "type": "array"
320540 }
335400 ]
341950 },
351950 "type": "object"
361950 },
370195 {
380195 "type": "null"
390195 }
401950 ],
411950}
Responses
codedescriptionhitsavg
200Successful Response37411ms
422Validation Error955ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1633ms
500Internal Server Error71634ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-created_at" ]sorting
Body
application/json176 / 185
ProductCreate
#validinvalidschema
16121444{
26121444 "anyOf": [
33171739 {
53171739 },
62951761 {
82951761 }
96121444 ]
106121444}
Referenced Components (12)213 of 222 keywords
AttachedCustomFieldCreate7 of 8 keywords
1586206{
2612120 "properties": {
366060 "custom_field_id": {
46600 "format": "uuid4",
566060 "type": "string"
666060 },
765860 "required": {
865860 "type": "boolean"
965860 }
10612120 },
1170626 "required": [
1272012 "custom_field_id",
1371814 "required"
1470626 ],
1573260 "type": "object"
16586206}
ProductCreateOneTime43 of 47 keywords
12951761{
23021739 "properties": {
31779133 "attached_custom_fields": {
41779103 "items": {
61779103 },
7188230 "type": "array"
81779133 },
9189124 "description": {
10189124 "anyOf": [
11661849 {
12661849 "type": "string"
13661849 },
14182590 {
15182590 "type": "null"
16182590 }
17189124 ],
18189124 },
19184760 "medias": {
20184760 "anyOf": [
21180998 {
22180936 "items": {
231660 "format": "uuid4",
2416642 "type": "string"
25180936 },
26184562 "type": "array"
27180998 },
28381869 {
29381869 "type": "null"
30381869 }
31184760 ],
32184760 },
33185442 "metadata": {
345212 "additionalProperties": {
3517512 "anyOf": [
3648139 {
37600 "maxLength": 500,
384812 "minLength": 1,
3960127 "type": "string"
4048139 },
4150137 {
4250137 "type": "integer"
4350137 },
4466121 {
4566121 "type": "number"
4666121 },
4761126 {
4861126 "type": "boolean"
4961126 }
5017512 ]
515212 },
5218660 "maxProperties": 50,
535212 "propertyNames": {
541816 "maxLength": 40,
551816 "minLength": 1
565212 },
57186630 "type": "object"
58185442 },
59199836 "name": {
6019986 "minLength": 3,
61200430 "type": "string"
62199836 },
63195424 "organization_id": {
64195424 "anyOf": [
65194830 {
6619480 "format": "uuid4",
67194830 "type": "string",
68194830 },
6961972 {
7061972 "type": "null"
7161972 }
72195424 ],
73195424 },
741048986 "prices": {
751054950 "items": {
761520963 "oneOf": [
778321651 {
798321651 },
802272256 {
822272256 },
831282355 {
851282355 },
861682315 {
881682315 },
891652318 {
911652318 }
921520963 ]
931054950 },
9419986 "minItems": 1,
95200430 "type": "array"
961048986 },
978971065 "recurring_interval": {
988971065 "type": "null"
998971065 },
100897990 "recurring_interval_count": {
101897990 "type": "null"
102897990 }
1033021739 },
104202813 "required": [
10520347 "name",
10620347 "prices"
107202813 ],
108204115 "type": "object"
1092951761}
ProductCreateRecurring55 of 59 keywords
13171739{
23881653 "properties": {
31779133 "attached_custom_fields": {
41779103 "items": {
61779103 },
7188230 "type": "array"
81779133 },
9189124 "description": {
10189124 "anyOf": [
11661849 {
12661849 "type": "string"
13661849 },
14182590 {
15182590 "type": "null"
16182590 }
17189124 ],
18189124 },
19184760 "medias": {
20184760 "anyOf": [
21180998 {
22180936 "items": {
231660 "format": "uuid4",
2416642 "type": "string"
25180936 },
26184562 "type": "array"
27180998 },
28381869 {
29381869 "type": "null"
30381869 }
31184760 ],
32184760 },
33185442 "metadata": {
345212 "additionalProperties": {
3517512 "anyOf": [
3648139 {
37600 "maxLength": 500,
384812 "minLength": 1,
3960127 "type": "string"
4048139 },
4150137 {
4250137 "type": "integer"
4350137 },
4466121 {
4566121 "type": "number"
4666121 },
4761126 {
4861126 "type": "boolean"
4961126 }
5017512 ]
515212 },
5218660 "maxProperties": 50,
535212 "propertyNames": {
541816 "maxLength": 40,
551816 "minLength": 1
565212 },
57186630 "type": "object"
58185442 },
59199836 "name": {
6019986 "minLength": 3,
61200430 "type": "string"
62199836 },
63195424 "organization_id": {
64195424 "anyOf": [
65194830 {
6619480 "format": "uuid4",
67194830 "type": "string",
68194830 },
6961972 {
7061972 "type": "null"
7161972 }
72195424 ],
73195424 },
741048986 "prices": {
751054950 "items": {
761520963 "oneOf": [
778321651 {
798321651 },
802272256 {
822272256 },
831282355 {
851282355 },
861682315 {
881682315 },
891652318 {
911652318 }
921520963 ]
931054950 },
9419986 "minItems": 1,
95200430 "type": "array"
961048986 },
971035927 "recurring_interval": {
991035927 },
100954933 "recurring_interval_count": {
1019633 "maximum": 999.0,
1029579 "minimum": 1.0,
103963924 "type": "integer"
104954933 },
10596015 "trial_interval": {
10696015 "anyOf": [
10724951 {
10924951 },
11093639 {
11193639 "type": "null"
11293639 }
11396015 ],
11496015 },
11594421 "trial_interval_count": {
11694421 "anyOf": [
11793827 {
1189443 "maximum": 1000.0,
1199416 "minimum": 1.0,
12094421 "type": "integer"
12193827 },
1226959 {
1236959 "type": "null"
1246959 }
12594421 ],
12694421 }
1273881653 },
128195091 "required": [
12920347 "name",
13020347 "prices",
131196279 "recurring_interval"
132195091 ],
133204115 "type": "object"
1343171739}
ProductPriceCustomCreate27 of 27 keywords
14544512{
25024392 "properties": {
38404006 "amount_type": {
48404006 "const": "custom",
54546300 "type": "string"
68404006 },
766696 "maximum_amount": {
866696 "anyOf": [
9604158 {
1064012 "maximum": 1000000.0,
1161636 "minimum": 50.0,
12640122 "type": "integer"
13604158 },
1462700 {
1562700 "type": "null"
1662700 }
1766696 ],
1866696 },
19642122 "minimum_amount": {
20642122 "anyOf": [
21600164 {
2264628 "maximum": 99999999.0,
2362846 "minimum": 50.0,
24662102 "type": "integer"
25600164 },
2642722 {
2742722 "type": "null"
2842722 }
29642122 ],
30642122 },
3164896 "preset_amount": {
3264896 "anyOf": [
33588156 {
3462412 "maximum": 1000000.0,
3560036 "minimum": 50.0,
36624120 "type": "integer"
37588156 },
3860684 {
3960684 "type": "null"
4060684 }
4164896 ],
4264896 },
432392288 "price_currency": {
44239248 "pattern": "usd",
452440240 "type": "string"
462392288 }
475024392 },
48484660 "required": [
49484660 "amount_type"
50484660 ],
51490660 "type": "object"
524544512}
ProductPriceFixedCreate12 of 12 keywords
116643302{
217243170 "properties": {
318443002 "amount_type": {
418443002 "const": "fixed",
54546300 "type": "string"
618443002 },
7182096 "price_amount": {
8184412 "maximum": 99999999.0,
9183224 "minimum": 50.0,
10184472 "type": "integer"
11182096 },
122392288 "price_currency": {
13239248 "pattern": "usd",
142440240 "type": "string"
152392288 }
1617243170 },
1719043002 "required": [
18484660 "amount_type",
1919162990 "price_amount"
2019043002 ],
21490660 "type": "object"
2216643302}
ProductPriceFreeCreate7 of 7 keywords
12564710{
22564590 "properties": {
32564590 "amount_type": {
42564590 "const": "free",
54546300 "type": "string"
62564590 }
72564590 },
8484660 "required": [
9484660 "amount_type"
10484660 ],
11490660 "type": "object"
122564710}
ProductPriceMeteredUnitCreate23 of 23 keywords
13304636{
24024492 "properties": {
36464200 "amount_type": {
46464200 "const": "metered_unit",
54546300 "type": "string"
66464200 },
753484 "cap_amount": {
853484 "anyOf": [
9480138 {
1050412 "maximum": 2147483647.0,
1150412 "minimum": 0.0,
12504114 "type": "integer"
13480138 },
1454564 {
1554564 "type": "null"
1654564 }
1753484 ],
1853484 },
19100064 "meter_id": {
2010004 "format": "uuid4",
21100460 "type": "string"
22100064 },
232392288 "price_currency": {
24239248 "pattern": "usd",
252440240 "type": "string"
262392288 },
2764672 "unit_amount": {
2864672 "anyOf": [
29522196 {
3052212 "exclusiveMinimum": 0.0,
31534184 "type": "number"
32522196 },
33124594 {
3412412 "pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,5}|(?=[\\d.]{1,18}0*$)\\d{0,5}\\.\\d{0,12}0*$)",
35136582 "type": "string"
36124594 }
3764672 ],
3864672 }
394024492 },
406944212 "required": [
41484660 "amount_type",
4210643842 "meter_id",
437184188 "unit_amount"
446944212 ],
45490660 "type": "object"
463304636}
ProductPriceSeatBasedCreate10 of 10 keywords
13364630{
23964498 "properties": {
39003946 "amount_type": {
49003946 "const": "seat_based",
54546300 "type": "string"
69003946 },
72392288 "price_currency": {
8239248 "pattern": "usd",
92440240 "type": "string"
102392288 },
11492480 "seat_tiers": {
13492480 }
143964498 },
159603946 "required": [
16484660 "amount_type",
179723934 "seat_tiers"
189603946 ],
19490660 "type": "object"
203364630}
ProductPriceSeatTier15 of 15 keywords
11254336{
21278252 "properties": {
374072 "max_seats": {
474072 "anyOf": [
5592220 {
659224 "minimum": 1.0,
7604208 "type": "integer"
8592220 },
9148664 {
10148664 "type": "null"
11148664 }
1274072 ],
1374072 },
14143484 "min_seats": {
15143424 "minimum": 1.0,
16144672 "type": "integer"
17143484 },
18142296 "price_per_seat": {
19144612 "maximum": 99999999.0,
20144612 "minimum": 0.0,
21144672 "type": "integer"
22142296 }
231278252 },
24150624 "required": [
25151812 "min_seats",
26151812 "price_per_seat"
27150624 ],
28153060 "type": "object"
291254336}
ProductPriceSeatTiers8 of 8 keywords
1492480{
2492408 "properties": {
3492408 "tiers": {
4504336 "items": {
6504336 },
782812 "minItems": 1,
884060 "type": "array"
9492408 }
10492408 },
1190012 "required": [
1290012 "tiers"
1390012 ],
1491260 "type": "object"
15492480}
SubscriptionRecurringInterval3 of 3 keywords
11035927{
21035927 "enum": [
3996n/a "day",
48n/a "week",
516n/a "month",
615n/a "year"
71035927 ],
81041921 "type": "string"
91035927}
TrialInterval3 of 3 keywords
124951{
224951 "enum": [
35n/a "day",
48n/a "week",
56n/a "month",
65n/a "year"
724951 ],
827948 "type": "string"
924951}
Responses
codedescriptionhitsavg
201Product created.0never seen
422Validation Error20306ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error371552ms
401Unauthorized163ms
400Bad Request14ms
Examples
Body: application/json
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"ProductCreateRecurring.organization_id.examples[0]
"usd"ProductPriceFixedCreate.price_currency
"usd"ProductPriceCustomCreate.price_currency
"usd"ProductPriceSeatBasedCreate.price_currency
"usd"ProductPriceMeteredUnitCreate.price_currency
1ProductCreateRecurring.recurring_interval_count
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"ProductCreateOneTime.organization_id.examples[0]
Path Parameters
id1 / 2
#validinvalidschema
14140{
24140 "format": "uuid4",
3414n/a "type": "string",
44140}
Responses
codedescriptionhitsavg
200Successful Response32210ms
404Product not found.307ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized622ms
Path Parameters
id2 / 2
#validinvalidschema
110635{
210635 "format": "uuid4",
31068n/a "type": "string",
410635}
Body
application/json150 / 156
ProductUpdate
1512514{
2290504 "properties": {
368152 "attached_custom_fields": {
468152 "anyOf": [
565182 {
665138 "items": {
865138 },
968944 "type": "array"
1065182 },
1130703 {
1230703 "type": "null"
1330703 }
1468152 ],
1568152 },
167058 "description": {
177058 "anyOf": [
1848665 {
1948665 "type": "string"
2048665 },
2165756 {
2265756 "type": "null"
2365756 }
247058 ],
257058 },
266998 "is_archived": {
276998 "anyOf": [
2834673 {
2934673 "type": "boolean"
3034673 },
3166542 {
3266542 "type": "null"
3366542 }
346998 ],
356998 },
3670020 "medias": {
3770020 "anyOf": [
3866753 {
3966712 "items": {
401090 "format": "uuid4",
4110914 "type": "string"
4266712 },
4367941 "type": "array"
4466753 },
4533687 {
4633687 "type": "null"
4733687 }
4870020 ],
4970020 },
5069515 "metadata": {
51405 "additionalProperties": {
521296 "anyOf": [
533996 {
54430 "maxLength": 500,
55394 "minLength": 1,
564392 "type": "string"
573996 },
5826109 {
5926109 "type": "integer"
6026109 },
613699 {
623699 "type": "number"
633699 },
645481 {
655481 "type": "boolean"
665481 }
671296 ]
68405 },
697000 "maxProperties": 50,
70414 "propertyNames": {
711332 "maxLength": 40,
721332 "minLength": 1
73414 },
7470010 "type": "object"
7569515 },
7669116 "name": {
7769116 "anyOf": [
7868522 {
796858 "minLength": 3,
8069314 "type": "string"
8168522 },
826701 {
836701 "type": "null"
846701 }
8569116 ],
8669116 },
87362346 "prices": {
88362346 "anyOf": [
89349359 {
90349337 "items": {
91182361 "anyOf": [
9232511 {
9432511 },
95150393 {
96150393 "oneOf": [
9727516 {
9927516 },
10048495 {
10248495 },
10311532 {
10511532 },
10621522 {
10821522 },
10943500 {
11143500 }
112150393 ]
113150393 }
114182361 ]
115349337 },
11668622 "type": "array"
117349359 },
11813695 {
11913695 "type": "null"
12013695 }
121362346 ],
122362346 },
12367316 "recurring_interval": {
12467316 "anyOf": [
12518671 {
12718671 },
12865534 {
12965534 "type": "null"
13065534 }
13167316 ],
13267316 },
13369515 "recurring_interval_count": {
13469515 "anyOf": [
13568228 {
1366863 "maximum": 999.0,
1376854 "minimum": 1.0,
13868723 "type": "integer"
13968228 },
14013697 {
14113697 "type": "null"
14213697 }
14369515 ],
14469515 },
14568210 "trial_interval": {
14668210 "anyOf": [
14725667 {
14925667 },
15065735 {
15165735 "type": "null"
15265735 }
15368210 ],
15468210 },
15567614 "trial_interval_count": {
15667614 "anyOf": [
15766030 {
1586642 "maximum": 1000.0,
1596624 "minimum": 1.0,
16066426 "type": "integer"
16166030 },
16216674 {
16316674 "type": "null"
16416674 }
16567614 ],
16667614 }
167290504 },
168101610 "type": "object"
169512514}
Referenced Components (11)120 of 123 keywords
AttachedCustomFieldCreate7 of 8 keywords
110740{
211122 "properties": {
311912 "custom_field_id": {
41190 "format": "uuid4",
511912 "type": "string"
611912 },
712110 "required": {
812110 "type": "boolean"
912110 }
1011122 },
111294 "required": [
121312 "custom_field_id",
131312 "required"
141294 ],
1513314 "type": "object"
1610740}
ExistingProductPrice6 of 7 keywords
132511{
23210 "properties": {
33210 "id": {
4320 "format": "uuid4",
53210 "type": "string"
63210 }
73210 },
842487 "required": [
942487 "id"
1042487 ],
1152914 "type": "object"
1232511}
ProductPriceCustomCreate27 of 27 keywords
148495{
256429 "properties": {
3112365 "amount_type": {
4112365 "const": "custom",
542750 "type": "string"
6112365 },
79620 "maximum_amount": {
89620 "anyOf": [
99422 {
101013 "maximum": 1000000.0,
11977 "minimum": 50.0,
1210115 "type": "integer"
139422 },
142114 {
152114 "type": "null"
162114 }
179620 ],
189620 },
199716 "minimum_amount": {
209716 "anyOf": [
218924 {
22952 "maximum": 99999999.0,
23916 "minimum": 50.0,
249518 "type": "integer"
258924 },
268105 {
278105 "type": "null"
288105 }
299716 ],
309716 },
319716 "preset_amount": {
329716 "anyOf": [
339221 {
34982 "maximum": 1000000.0,
35946 "minimum": 50.0,
369815 "type": "integer"
379221 },
385108 {
395108 "type": "null"
405108 }
419716 ],
429716 },
4334848 "price_currency": {
443488 "pattern": "usd",
4535640 "type": "string"
4634848 }
4756429 },
4847752 "required": [
4947752 "amount_type"
5047752 ],
5152914 "type": "object"
5248495}
ProductPriceFixedCreate12 of 12 keywords
127516{
237448 "properties": {
357420 "amount_type": {
457420 "const": "fixed",
542750 "type": "string"
657420 },
75316 "price_amount": {
8572 "maximum": 99999999.0,
9554 "minimum": 50.0,
105712 "type": "integer"
115316 },
1234848 "price_currency": {
133488 "pattern": "usd",
1435640 "type": "string"
1534848 }
1637448 },
1767462 "required": [
1847752 "amount_type",
1969460 "price_amount"
2067462 ],
2152914 "type": "object"
2227516}
ProductPriceFreeCreate7 of 7 keywords
111532{
211466 "properties": {
311466 "amount_type": {
411466 "const": "free",
542750 "type": "string"
611466 }
711466 },
847752 "required": [
947752 "amount_type"
1047752 ],
1152914 "type": "object"
1211532}
ProductPriceMeteredUnitCreate22 of 23 keywords
143500{
255430 "properties": {
3122355 "amount_type": {
4122355 "const": "metered_unit",
542750 "type": "string"
6122355 },
77841 "cap_amount": {
87841 "anyOf": [
97544 {
108510 "maximum": 2147483647.0,
11878 "minimum": 0.0,
129326 "type": "integer"
137544 },
143116 {
153116 "type": "null"
163116 }
177841 ],
187841 },
1912410 "meter_id": {
201240 "format": "uuid4",
2112410 "type": "string"
2212410 },
2334848 "price_currency": {
243488 "pattern": "usd",
2535640 "type": "string"
2634848 },
2712212 "unit_amount": {
2812212 "anyOf": [
299440 {
30942 "exclusiveMinimum": 0.0,
319638 "type": "number"
329440 },
3328106 {
34282 "pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,5}|(?=[\\d.]{1,18}0*$)\\d{0,5}\\.\\d{0,12}0*$)",
3530104 "type": "string"
3628106 }
3712212 ],
3812212 }
3955430 },
40130399 "required": [
4147752 "amount_type",
42134395 "meter_id",
43134395 "unit_amount"
44130399 ],
4552914 "type": "object"
4643500}
ProductPriceSeatBasedCreate10 of 10 keywords
121522{
231454 "properties": {
3115362 "amount_type": {
4115362 "const": "seat_based",
542750 "type": "string"
6115362 },
734848 "price_currency": {
83488 "pattern": "usd",
935640 "type": "string"
1034848 },
114780 "seat_tiers": {
134780 }
1431454 },
15125404 "required": [
1647752 "amount_type",
17127402 "seat_tiers"
18125404 ],
1952914 "type": "object"
2021522}
ProductPriceSeatTier15 of 15 keywords
15656{
26042 "properties": {
35312 "max_seats": {
45312 "anyOf": [
54817 {
6484 "minimum": 1.0,
75015 "type": "integer"
84817 },
9560 {
10560 "type": "null"
11560 }
125312 ],
135312 },
148614 "min_seats": {
15864 "minimum": 1.0,
168812 "type": "integer"
178614 },
188416 "price_per_seat": {
19882 "maximum": 99999999.0,
20882 "minimum": 0.0,
218812 "type": "integer"
228416 }
236042 },
24984 "required": [
251002 "min_seats",
261002 "price_per_seat"
27984 ],
2810210 "type": "object"
295656}
ProductPriceSeatTiers8 of 8 keywords
14780{
24768 "properties": {
34768 "tiers": {
44956 "items": {
64956 },
71032 "minItems": 1,
810510 "type": "array"
94768 }
104768 },
111152 "required": [
121152 "tiers"
131152 ],
1411710 "type": "object"
154780}
SubscriptionRecurringInterval3 of 3 keywords
118671{
218671 "enum": [
33n/a "day",
44n/a "week",
56n/a "month",
65n/a "year"
718671 ],
826663 "type": "string"
918671}
TrialInterval3 of 3 keywords
125667{
225667 "enum": [
36n/a "day",
49n/a "week",
56n/a "month",
64n/a "year"
725667 ],
827665 "type": "string"
925667}
Responses
codedescriptionhitsavg
200Product updated.22824ms
403You don't have the permission to update this product.0never seen
404Product not found.178ms
422Validation Error7566ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized383ms
500Internal Server Error191233ms
400Bad Request106ms
Examples
Body: application/json
"usd"ProductPriceFixedCreate.price_currency
"usd"ProductPriceCustomCreate.price_currency
"usd"ProductPriceSeatBasedCreate.price_currency
"usd"ProductPriceMeteredUnitCreate.price_currency
Path Parameters
id2 / 2
#validinvalidschema
14922{
24922 "format": "uuid4",
3494n/a "type": "string",
44922}
Body
application/json5 / 6
ProductBenefitsUpdate
145331{
245320 "properties": {
345320 "benefits": {
44535 "items": {
51280 "format": "uuid4",
61285 "type": "string",
74535 },
845815 "type": "array"
945320 }
1045320 },
114735 "required": [
124735 "benefits"
134735 ],
144786 "type": "object"
1545331}
Responses
codedescriptionhitsavg
200Product benefits updated.34731ms
403You don't have the permission to update this product.0never seen
404Product not found.487ms
422Validation Error618ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized383ms
refunds 2 operations 0 covered 2 partial 0 uncovered 0 not measured 64% #
Query Parameters
id4 / 7
#validinvalidschema
124769{
224769 "anyOf": [
30316 {
400 "format": "uuid4",
50n/a "type": "string"
60316 },
724769 {
824769 "items": {
9432155 "format": "uuid4",
10587n/a "type": "string"
1124769 },
123160 "type": "array"
1324769 },
140316 {
150316 "type": "null"
160316 }
1724769 ],
1824769}
organization_id2 / 7
17100{
27100 "anyOf": [
30710 {
400 "format": "uuid4",
50n/a "type": "string",
60710 },
77100 {
87100 "items": {
97100 "format": "uuid4",
10710n/a "type": "string",
117100 },
127100 "type": "array"
137100 },
140710 {
150710 "type": "null"
160710 }
177100 ],
187100}
order_id4 / 7
123329{
223329 "anyOf": [
30262 {
400 "format": "uuid4",
50n/a "type": "string"
60262 },
723329 {
823329 "items": {
981732 "format": "uuid4",
10849n/a "type": "string"
1123329 },
122620 "type": "array"
1323329 },
140262 {
150262 "type": "null"
160262 }
1723329 ],
1823329}
subscription_id4 / 7
136197{
236197 "anyOf": [
30458 {
400 "format": "uuid4",
50n/a "type": "string"
60458 },
736197 {
836197 "items": {
942393 "format": "uuid4",
10516n/a "type": "string"
1136197 },
124580 "type": "array"
1336197 },
140458 {
150458 "type": "null"
160458 }
1736197 ],
1836197}
customer_id4 / 7
1213137{
2213137 "anyOf": [
30350 {
400 "format": "uuid4",
50n/a "type": "string"
60350 },
7213137 {
8213137 "items": {
9457739 "format": "uuid4",
101196n/a "type": "string"
11213137 },
123500 "type": "array"
13213137 },
140350 {
150350 "type": "null"
160350 }
17213137 ],
18213137}
succeeded3 / 3
116815{
216815 "anyOf": [
313944 {
413944 "type": "boolean"
513944 },
629154 {
729154 "type": "null"
829154 }
916815 ],
1016815}
page2 / 2
129729{
22972 "exclusiveMinimum": 0,
329927 "type": "integer"
429729}
limit2 / 2
129521{
22952 "exclusiveMinimum": 0,
329719 "type": "integer"
429521}
sorting4 / 6
116825{
216825 "anyOf": [
316825 {
416825 "items": {
616825 },
71930 "type": "array"
816825 },
90193 {
100193 "type": "null"
110193 }
1216825 ],
1316825}
Referenced Components (1)3 of 3 keywords
RefundSortProperty3 of 3 keywords
173627{
273627 "enum": [
3133n/a "created_at",
4155n/a "-created_at",
5284n/a "amount",
6164n/a "-amount"
773627 ],
8738n/a "type": "string"
973627}
Responses
codedescriptionhitsavg
200Successful Response4037ms
422Validation Error1826ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1143ms
500Internal Server Error111545ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-created_at" ]sorting
Body
application/json23 / 25
RefundCreate
#validinvalidschema
127795{
228978 "properties": {
33597 "amount": {
43601 "exclusiveMinimum": 0.0,
53606 "type": "integer"
63597 },
716318 "comment": {
816318 "anyOf": [
99289 {
109289 "type": "string"
119289 },
1271110 {
1371110 "type": "null"
1471110 }
1516318 ],
1616318 },
1716723 "metadata": {
188018 "additionalProperties": {
1926131 "anyOf": [
20104188 {
211100 "maxLength": 500,
221046 "minLength": 1,
23110182 "type": "string"
24104188 },
2556236 {
2656236 "type": "integer"
2756236 },
2880212 {
2980212 "type": "number"
3080212 },
3177215 {
3277215 "type": "boolean"
3377215 }
3426131 ]
358018 },
361850 "maxProperties": 50,
37962 "propertyNames": {
382911 "maxLength": 40,
392911 "minLength": 1
40962 },
411855 "type": "object"
4216723 },
433507 "order_id": {
443501 "format": "uuid4",
453516 "type": "string"
463507 },
4734521 "reason": {
4934521 },
5015120 "revoke_benefits": {
5115120 "type": "boolean"
5215120 }
5328978 },
5435512 "required": [
5535710 "order_id",
563661 "reason",
573661 "amount"
5835512 ],
593675 "type": "object"
6027795}
Referenced Components (1)3 of 3 keywords
RefundReason3 of 3 keywords
134521{
234521 "enum": [
3107n/a "duplicate",
425n/a "fraudulent",
555n/a "customer_request",
625n/a "service_disruption",
732n/a "satisfaction_guarantee",
8101n/a "other"
934521 ],
103615 "type": "string"
1134521}
Responses
codedescriptionhitsavg
200Successful Response0never seen
201Refund created.0never seen
400Refund amount exceeds remaining order balance.1455ms
403Order is already fully refunded.0never seen
422Validation Error4148ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized303ms
Examples
Body: application/json
falseRefundCreate.revoke_benefits
storefronts 3 operations 3 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters
product_id1 / 1
#validinvalidschema
1252n/a{
2252n/a "type": "string"
3252n/a}
Responses
codedescriptionhitsavg
200Successful Response2303ms
404Organization not found.0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error221285ms
Path Parameters
subscription_id1 / 1
#validinvalidschema
1191n/a{
2191n/a "type": "string"
3191n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Organization not found.1604ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error311308ms
Path Parameters
slug1 / 1
#validinvalidschema
17n/a{
27n/a "type": "string"
37n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Organization not found.74ms
422Validation Error0never seen
subscriptions 7 operations 3 covered 4 partial 0 uncovered 0 not measured 77% #
Query Parameters
organization_id2 / 7
#validinvalidschema
15360{
25360 "anyOf": [
30536 {
400 "format": "uuid4",
50n/a "type": "string",
60536 },
75360 {
85360 "items": {
95360 "format": "uuid4",
10536n/a "type": "string",
115360 },
125360 "type": "array"
135360 },
140536 {
150536 "type": "null"
160536 }
175360 ],
185360}
product_id4 / 7
14401{
24401 "anyOf": [
30441 {
400 "format": "uuid4",
50n/a "type": "string",
60441 },
74401 {
84401 "items": {
95072 "format": "uuid4",
10509n/a "type": "string",
114401 },
124410 "type": "array"
134401 },
140441 {
150441 "type": "null"
160441 }
174401 ],
184401}
customer_id4 / 7
12603{
22603 "anyOf": [
30263 {
400 "format": "uuid4",
50n/a "type": "string"
60263 },
72603 {
82603 "items": {
950911 "format": "uuid4",
10520n/a "type": "string"
112603 },
122630 "type": "array"
132603 },
140263 {
150263 "type": "null"
160263 }
172603 ],
182603}
external_customer_id3 / 5
1227n/a{
2227n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
622770 {
7227n/a "items": {
8259n/a "type": "string"
9227n/a },
102970 "type": "array"
1122770 },
120297 {
130297 "type": "null"
140297 }
15227n/a ],
16227n/a}
discount_id4 / 7
12424{
22424 "anyOf": [
30246 {
400 "format": "uuid4",
50n/a "type": "string",
60246 },
72424 {
82424 "items": {
94862 "format": "uuid4",
10488n/a "type": "string",
112424 },
122460 "type": "array"
132424 },
140246 {
150246 "type": "null"
160246 }
172424 ],
182424}
active3 / 3
11506{
21506 "anyOf": [
31488 {
41488 "type": "boolean"
51488 },
62154 {
72154 "type": "null"
82154 }
91506 ],
101506}
cancel_at_period_end3 / 3
11587{
21587 "anyOf": [
31569 {
41569 "type": "boolean"
51569 },
62163 {
72163 "type": "null"
82163 }
91587 ],
101587}
page2 / 2
129417{
22944 "exclusiveMinimum": 0,
329813 "type": "integer"
429417}
limit2 / 2
131915{
23192 "exclusiveMinimum": 0,
332113 "type": "integer"
431915}
sorting4 / 6
115612{
215612 "anyOf": [
315612 {
415612 "items": {
615612 },
71680 "type": "array"
815612 },
90168 {
100168 "type": "null"
110168 }
1215612 ],
1315612}
Referenced Components (1)3 of 3 keywords
SubscriptionSortProperty3 of 3 keywords
154414{
254414 "enum": [
321n/a "customer",
427n/a "-customer",
531n/a "status",
640n/a "-status",
716n/a "started_at",
888n/a "-started_at",
933n/a "current_period_end",
1019n/a "-current_period_end",
11103n/a "amount",
1239n/a "-amount",
1347n/a "product",
1427n/a "-product",
1522n/a "discount",
1631n/a "-discount"
1754414 ],
18546n/a "type": "string"
1954414}
metadata4 / 13
MetadataQuery
11330{
21330 "anyOf": [
31330 {
41330 "additionalProperties": {
53690 "anyOf": [
6255114 {
7255114 "type": "string"
8255114 },
90369 {
100369 "type": "integer"
110369 },
120369 {
130369 "type": "boolean"
140369 },
15114255 {
161140 "items": {
179260 "type": "string"
181140 },
19114255 "type": "array"
20114255 },
210369 {
220114 "items": {
230926 "type": "integer"
240114 },
25114255 "type": "array"
260369 },
270369 {
280114 "items": {
290926 "type": "boolean"
300114 },
31114255 "type": "array"
320369 }
333690 ]
341330 },
351330 "type": "object"
361330 },
370133 {
380133 "type": "null"
390133 }
401330 ],
411330}
Responses
codedescriptionhitsavg
200Successful Response33111ms
422Validation Error545ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1462ms
500Internal Server Error51710ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-started_at" ]sorting
Body
application/json36 / 38
#validinvalidschema
1233105{
2233105 "anyOf": [
3156182 {
5156182 },
677261 {
877261 }
9233105 ],
10233105}
Referenced Components (2)39 of 41 keywords
SubscriptionCreateCustomer20 of 21 keywords
1156182{
224664 "properties": {
317513 "customer_id": {
41751 "format": "uuid4",
517612 "type": "string"
617513 },
710535 "metadata": {
85122 "additionalProperties": {
917644 "anyOf": [
1048172 {
115521 "maxLength": 500,
12697 "minLength": 1,
1376144 "type": "string"
1448172 },
1554166 {
1654166 "type": "integer"
1754166 },
1879141 {
1979141 "type": "number"
2079141 },
2149171 {
2249171 "type": "boolean"
2349171 }
2417644 ]
255122 },
261270 "maxProperties": 50,
27694 "propertyNames": {
282182 "maxLength": 40,
292182 "minLength": 1
30694 },
3112713 "type": "object"
3210535 },
3326639 "product_id": {
342669 "format": "uuid4",
3527530 "type": "string"
3626639 }
3724664 },
38187135 "required": [
3930517 "product_id",
40188134 "customer_id"
41187135 ],
4232216 "type": "object"
43156182}
SubscriptionCreateExternalCustomer19 of 20 keywords
177261{
224863 "properties": {
310411 "external_customer_id": {
410411 "type": "string"
510411 },
610535 "metadata": {
75122 "additionalProperties": {
817644 "anyOf": [
948172 {
105521 "maxLength": 500,
11697 "minLength": 1,
1276144 "type": "string"
1348172 },
1454166 {
1554166 "type": "integer"
1654166 },
1779141 {
1879141 "type": "number"
1979141 },
2049171 {
2149171 "type": "boolean"
2249171 }
2317644 ]
245122 },
251270 "maxProperties": 50,
26694 "propertyNames": {
272182 "maxLength": 40,
282182 "minLength": 1
29694 },
3012713 "type": "object"
3110535 },
3226639 "product_id": {
332669 "format": "uuid4",
3427530 "type": "string"
3526639 }
3624863 },
37110212 "required": [
3830517 "product_id",
39115207 "external_customer_id"
40110212 ],
4132216 "type": "object"
4277261}
Responses
codedescriptionhitsavg
201Subscription created.0never seen
422Validation Error3897ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request676ms
401Unauthorized82ms
Examples
Body: application/json
"992fae2a-2a17-4b7a-8d9e-e287cf90131b"SubscriptionCreateCustomer.customer_id.examples[0]
"d8dd2de1-21b7-4a41-8bc3-ce909c0cfe23"SubscriptionCreateCustomer.product_id.examples[0]
"d8dd2de1-21b7-4a41-8bc3-ce909c0cfe23"SubscriptionCreateExternalCustomer.product_id.examples[0]
Query Parameters
organization_id2 / 7
#validinvalidschema
14700{
24700 "anyOf": [
30470 {
400 "format": "uuid4",
50n/a "type": "string",
60470 },
74700 {
84700 "items": {
94700 "format": "uuid4",
10470n/a "type": "string",
114700 },
124700 "type": "array"
134700 },
140470 {
150470 "type": "null"
160470 }
174700 ],
184700}
Responses
codedescriptionhitsavg
200Successful Response637ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4072ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
Path Parameters
id2 / 2
#validinvalidschema
111219{
211219 "format": "uuid4",
3131n/a "type": "string"
411219}
Responses
codedescriptionhitsavg
200Subscription revoked.0never seen
403This subscription is already revoked.0never seen
404Subscription not found.10310ms
409Subscription is pending an update.0never seen
422Validation Error176ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized112ms
Path Parameters
id2 / 2
#validinvalidschema
138326{
238326 "format": "uuid4",
3409n/a "type": "string"
438326}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Subscription not found.3457ms
422Validation Error266ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized382ms
Path Parameters
id2 / 2
#validinvalidschema
16478{
26478 "format": "uuid4",
3655n/a "type": "string"
46478}
Body
application/json67 / 69
SubscriptionUpdate
1462170{
2462170 "anyOf": [
3261371 {
5261371 },
636596 {
836596 },
922610 {
1122610 },
1233599 {
1433599 },
1522610 {
1722610 },
1842590 {
2042590 },
2148584 {
2348584 }
24462170 ]
25462170}
Referenced Components (9)83 of 85 keywords
CustomerCancellationReason3 of 3 keywords
174162{
274162 "enum": [
38n/a "customer_service",
48n/a "low_quality",
58n/a "missing_features",
68n/a "switched_service",
712n/a "too_complex",
88n/a "too_expensive",
914n/a "unused",
108n/a "other"
1174162 ],
1282154 "type": "string"
1374162}
SubscriptionCancel14 of 14 keywords
142590{
29346 "properties": {
36010 "cancel_at_period_end": {
46010 "type": "boolean"
56010 },
610216 "customer_cancellation_comment": {
710216 "anyOf": [
89109 {
99109 "type": "string"
109109 },
119325 {
129325 "type": "null"
139325 }
1410216 ],
1510216 },
169820 "customer_cancellation_reason": {
179820 "anyOf": [
183781 {
203781 },
216157 {
226157 "type": "null"
236157 }
249820 ],
259820 }
269346 },
2770545 "required": [
2870545 "cancel_at_period_end"
2970545 ],
3061517 "type": "object"
3142590}
SubscriptionProrationBehavior3 of 3 keywords
132122{
232122 "enum": [
320n/a "invoice",
412n/a "prorate"
532122 ],
644110 "type": "string"
732122}
SubscriptionRevoke15 of 15 keywords
148584{
29048 "properties": {
310216 "customer_cancellation_comment": {
410216 "anyOf": [
59109 {
69109 "type": "string"
79109 },
89325 {
99325 "type": "null"
109325 }
1110216 ],
1210216 },
139820 "customer_cancellation_reason": {
149820 "anyOf": [
153781 {
173781 },
186157 {
196157 "type": "null"
206157 }
219820 ],
229820 },
236612 "revoke": {
246612 "const": true,
256612 "type": "boolean"
266612 }
279048 },
2878537 "required": [
2978537 "revoke"
3078537 ],
3161517 "type": "object"
3248584}
SubscriptionUpdateBillingPeriod7 of 7 keywords
122610{
22212 "properties": {
32212 "current_billing_period_end": {
4222 "format": "date-time",
52410 "type": "string"
62212 }
72212 },
834581 "required": [
934581 "current_billing_period_end"
1034581 ],
1161517 "type": "object"
1222610}
SubscriptionUpdateDiscount9 of 10 keywords
136596{
2368 "properties": {
3368 "discount_id": {
4368 "anyOf": [
52420 {
6240 "format": "uuid4",
72420 "type": "string"
82420 },
91232 {
101232 "type": "null"
111232 }
12368 ],
13368 }
14368 },
1544571 "required": [
1644571 "discount_id"
1744571 ],
1861517 "type": "object"
1936596}
SubscriptionUpdateProduct10 of 11 keywords
1261371{
228832 "properties": {
327110 "product_id": {
42710 "format": "uuid4",
527110 "type": "string"
627110 },
75522 "proration_behavior": {
85522 "anyOf": [
91661 {
111661 },
123938 {
133938 "type": "null"
143938 }
155522 ],
165522 }
1728832 },
18281334 "required": [
19281334 "product_id"
20281334 ],
2161517 "type": "object"
22261371}
SubscriptionUpdateSeats11 of 11 keywords
133599{
26236 "properties": {
35522 "proration_behavior": {
45522 "anyOf": [
51661 {
71661 },
83938 {
93938 "type": "null"
103938 }
115522 ],
125522 },
134415 "seats": {
14445 "minimum": 1.0,
154712 "type": "integer"
164415 }
176236 },
1859556 "required": [
1959556 "seats"
2059556 ],
2161517 "type": "object"
2233599}
SubscriptionUpdateTrial11 of 11 keywords
122610{
22214 "properties": {
32214 "trial_end": {
42214 "anyOf": [
51125 {
61115 "format": "date-time",
72610 "type": "string"
81125 },
91125 {
101125 "const": "now",
112610 "type": "string"
121125 }
132214 ],
142214 }
152214 },
1636579 "required": [
1736579 "trial_end"
1836579 ],
1961517 "type": "object"
2022610}
Responses
codedescriptionhitsavg
200Subscription updated.0never seen
403Subscription is already canceled or will be at the end of the period.0never seen
404Subscription not found.4207ms
409Subscription is pending an update.0never seen
422Validation Error2166ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized152ms
400Bad Request45ms
Examples
Body: application/json
"d8dd2de1-21b7-4a41-8bc3-ce909c0cfe23"SubscriptionUpdateProduct.product_id.examples[0]
Path Parameters
id2 / 2
#validinvalidschema
138326{
238326 "format": "uuid4",
3409n/a "type": "string"
438326}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Subscription not found.3527ms
422Validation Error265ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized312ms
transactions 3 operations 2 covered 1 partial 0 uncovered 0 not measured 94% #
Query Parameters
transaction_id2 / 2
#validinvalidschema
145455{
245455 "format": "uuid4",
3509n/a "type": "string"
445455}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error5611ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3969ms
401Unauthorized582ms
Query Parameters
account_id2 / 2
#validinvalidschema
137634{
237634 "format": "uuid4",
3410n/a "type": "string"
437634}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error355ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3166ms
401Unauthorized602ms
users 5 operations 4 covered 0 partial 1 uncovered 0 not measured 100% #
Expected Responses
codedescriptionhitsavg
200Deletion result0never seen
Responses
codedescriptionhitsavg
200Successful Response1645ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4442ms
Responses
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error16930ms
401Unauthorized2682ms
Path Parameters
platform2 / 2
OAuthPlatform
#validinvalidschema
1184268{
2184268 "enum": [
329n/a "github",
424n/a "github_repository_benefit",
523n/a "google",
6108n/a "apple"
7184268 ],
8452n/a "type": "string"
9184268}
Responses
codedescriptionhitsavg
204Successful Response0never seen
400Cannot disconnect last authentication method0never seen
404OAuth account not found496ms
422Validation Error2685ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1352ms
Responses
codedescriptionhitsavg
200Successful Response335ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized4342ms
wallets 3 operations 2 covered 1 partial 0 uncovered 0 not measured 63% #
Query Parameters
organization_id2 / 7
#validinvalidschema
17150{
27150 "anyOf": [
30715 {
400 "format": "uuid4",
50n/a "type": "string",
60715 },
77150 {
87150 "items": {
97150 "format": "uuid4",
10715n/a "type": "string",
117150 },
127150 "type": "array"
137150 },
140715 {
150715 "type": "null"
160715 }
177150 ],
187150}
type4 / 7
1182129{
2182129 "anyOf": [
30311 {
50311 },
6182129 {
7182129 "items": {
9182129 },
103110 "type": "array"
11182129 },
120311 {
130311 "type": "null"
140311 }
15182129 ],
16182129}
Referenced Components (1)3 of 3 keywords
WalletType3 of 3 keywords
1596554{
2596554 "enum": [
3279n/a "usage",
4317n/a "billing"
5596554 ],
6781n/a "type": "string"
7596554}
customer_id4 / 7
122768{
222768 "anyOf": [
30295 {
400 "format": "uuid4",
50n/a "type": "string"
60295 },
722768 {
822768 "items": {
9590229 "format": "uuid4",
10819n/a "type": "string"
1122768 },
122950 "type": "array"
1322768 },
140295 {
150295 "type": "null"
160295 }
1722768 ],
1822768}
page2 / 2
132327{
23238 "exclusiveMinimum": 0,
333119 "type": "integer"
432327}
limit2 / 2
131171{
231114 "exclusiveMinimum": 0,
332557 "type": "integer"
431171}
sorting4 / 6
1144162{
2144162 "anyOf": [
3144162 {
4144162 "items": {
6144162 },
73060 "type": "array"
8144162 },
90306 {
100306 "type": "null"
110306 }
12144162 ],
13144162}
Referenced Components (1)3 of 3 keywords
WalletSortProperty3 of 3 keywords
1770676{
2770676 "enum": [
3127n/a "created_at",
4158n/a "-created_at",
5321n/a "balance",
6164n/a "-balance"
7770676 ],
81372n/a "type": "string"
9770676}
Responses
codedescriptionhitsavg
200Successful Response3768ms
422Validation Error2365ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1012ms
500Internal Server Error21423ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-created_at" ]sorting
Path Parameters
id2 / 2
#validinvalidschema
135360{
235360 "format": "uuid4",
3413n/a "type": "string"
435360}
Responses
codedescriptionhitsavg
200Successful Response0never seen
404Wallet not found.3217ms
422Validation Error605ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized322ms
Path Parameters
id2 / 2
#validinvalidschema
151937{
251937 "format": "uuid4",
3556n/a "type": "string"
451937}
Body
application/json6 / 6
WalletTopUpCreate
146552{
247622 "properties": {
347814 "amount": {
447814 "type": "integer"
547814 },
647815 "currency": {
74785 "pattern": "usd",
848310 "type": "string"
947815 }
1047622 },
1148725 "required": [
1249220 "amount",
1349319 "currency"
1448725 ],
155125 "type": "object"
1646552}
Responses
codedescriptionhitsavg
200Successful Response0never seen
201Wallet topped up successfully.0never seen
400The payment request failed.106ms
402No payment method available.0never seen
404Wallet not found.4397ms
422Validation Error956ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized123ms
Examples
Body: application/json
2000WalletTopUpCreate.amount.examples[0]
webhooks 8 operations 6 covered 2 partial 0 uncovered 0 not measured 88% #
Query Parameters
endpoint_id4 / 7
#validinvalidschema
139637{
239637 "anyOf": [
30433 {
400 "format": "uuid4",
50n/a "type": "string"
60433 },
739637 {
839637 "items": {
941435 "format": "uuid4",
10449n/a "type": "string"
1139637 },
124330 "type": "array"
1339637 },
140433 {
150433 "type": "null"
160433 }
1739637 ],
1839637}
start_timestamp4 / 4
117240{
217240 "anyOf": [
317042 {
417040 "format": "date-time",
5210n/a "type": "string"
617042 },
72210 {
82210 "type": "null"
92210 }
1017240 ],
1117240}
end_timestamp4 / 4
116652{
216652 "anyOf": [
316454 {
416452 "format": "date-time",
5216n/a "type": "string"
616454 },
72216 {
82216 "type": "null"
92216 }
1016652 ],
1116652}
page2 / 2
120330{
22038 "exclusiveMinimum": 0,
321122 "type": "integer"
420330}
limit2 / 2
123321{
22336 "exclusiveMinimum": 0,
323915 "type": "integer"
423321}
Responses
codedescriptionhitsavg
200Successful Response3538ms
422Validation Error786ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1142ms
500Internal Server Error71428ms
Examples
Query
1page
10limit
Query Parameters
organization_id2 / 7
#validinvalidschema
16200{
26200 "anyOf": [
30620 {
400 "format": "uuid4",
50n/a "type": "string",
60620 },
76200 {
86200 "items": {
96200 "format": "uuid4",
10620n/a "type": "string",
116200 },
126200 "type": "array"
136200 },
140620 {
150620 "type": "null"
160620 }
176200 ],
186200}
page2 / 2
1178263{
217894 "exclusiveMinimum": 0,
3272169 "type": "integer"
4178263}
limit2 / 2
1169282{
216994 "exclusiveMinimum": 0,
3263188 "type": "integer"
4169282}
Responses
codedescriptionhitsavg
200Successful Response2677ms
422Validation Error2846ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized413ms
500Internal Server Error281130ms
Examples
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
Body
application/json22 / 22
WebhookEndpointCreate
#validinvalidschema
1556111{
256691 "properties": {
363223 "events": {
463213 "items": {
663213 },
764510 "type": "array"
863223 },
963322 "format": {
1163322 },
126459 "organization_id": {
136459 "anyOf": [
1464311 {
156431 "format": "uuid4",
1664410 "type": "string",
1764311 },
182652 {
192652 "type": "null"
202652 }
216459 ],
226459 },
2325422 "secret": {
2425422 "anyOf": [
2523739 {
262376 "minLength": 32,
2724333 "type": "string"
2823739 },
2917259 {
3017259 "type": "null"
3117259 }
3225422 ],
3325422 },
3462229 "url": {
356286 "format": "uri",
366286 "maxLength": 2083,
376304 "minLength": 1,
3863417 "type": "string"
3962229 }
4056691 },
4164710 "required": [
426516 "url",
436552 "format",
446552 "events"
4564710 ],
4665710 "type": "object"
47556111}
Referenced Components (2)6 of 6 keywords
WebhookEventType3 of 3 keywords
1121713{
2121713 "enum": [
321n/a "checkout.created",
457n/a "checkout.updated",
547n/a "customer.created",
619n/a "customer.updated",
747n/a "customer.deleted",
823n/a "customer.state_changed",
941n/a "customer_seat.assigned",
1030n/a "customer_seat.claimed",
1129n/a "customer_seat.revoked",
1234n/a "order.created",
1334n/a "order.updated",
1467n/a "order.paid",
1536n/a "order.refunded",
1631n/a "subscription.created",
1733n/a "subscription.updated",
1835n/a "subscription.active",
1923n/a "subscription.canceled",
2032n/a "subscription.uncanceled",
21185n/a "subscription.revoked",
2248n/a "refund.created",
2331n/a "refund.updated",
2426n/a "product.created",
2556n/a "product.updated",
2634n/a "benefit.created",
2722n/a "benefit.updated",
2827n/a "benefit_grant.created",
2928n/a "benefit_grant.cycled",
3041n/a "benefit_grant.updated",
3146n/a "benefit_grant.revoked",
3234n/a "organization.updated"
33121713 ],
34122010 "type": "string"
35121713}
WebhookFormat3 of 3 keywords
163322{
263322 "enum": [
3318n/a "raw",
4118n/a "discord",
5197n/a "slack"
663322 ],
763817 "type": "string"
863322}
Responses
codedescriptionhitsavg
201Webhook endpoint created.30825ms
422Validation Error3626ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized252ms
500Internal Server Error41329ms
400Bad Request125ms
Examples
Body: application/json
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"WebhookEndpointCreate.organization_id.examples[0]
"polar_whs_ovyN6cPrTv56AApvzCaJno08SSmGJmgbWilb33N2JuK"WebhookEndpointCreate.secret.examples[0]
"https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0"WebhookEndpointCreate.url.examples[0]
Path Parameters
id2 / 2
#validinvalidschema
1558{
2558 "format": "uuid4",
363n/a "type": "string"
4558}
Responses
codedescriptionhitsavg
204Webhook endpoint deleted.379ms
404Webhook endpoint not found.96ms
422Validation Error85ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized92ms
Path Parameters
id2 / 2
#validinvalidschema
14044{
24044 "format": "uuid4",
3408n/a "type": "string"
44044}
Responses
codedescriptionhitsavg
200Successful Response3796ms
404Webhook endpoint not found.86ms
422Validation Error46ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized172ms
Path Parameters
id2 / 2
#validinvalidschema
14993{
24993 "format": "uuid4",
3502n/a "type": "string"
44993}
Body
application/json26 / 26
WebhookEndpointUpdate
140873{
212761 "properties": {
31237 "enabled": {
41237 "anyOf": [
519111 {
619111 "type": "boolean"
719111 },
810426 {
910426 "type": "null"
1010426 }
111237 ],
121237 },
1310819 "events": {
1410819 "anyOf": [
159334 {
16937 "items": {
18937 },
1910027 "type": "array"
209334 },
2115112 {
2215112 "type": "null"
2315112 }
2410819 ],
2510819 },
2612218 "format": {
2712218 "anyOf": [
2819121 {
3019121 },
3110337 {
3210337 "type": "null"
3310337 }
3412218 ]
3512218 },
3611216 "secret": {
3711216 "anyOf": [
3810424 {
391043 "minLength": 32,
4010721 "type": "string"
4110424 },
428120 {
438120 "type": "null"
448120 }
4511216 ],
4611216 },
4711218 "url": {
4811218 "anyOf": [
4910228 {
501034 "format": "uri",
511061 "maxLength": 2083,
521052 "minLength": 1,
5310723 "type": "string"
5410228 },
5510120 {
5610120 "type": "null"
5710120 }
5811218 ],
5911218 }
6012761 },
6146912 "type": "object"
6240873}
Referenced Components (2)6 of 6 keywords
WebhookEventType3 of 3 keywords
1898{
2898 "enum": [
35n/a "checkout.created",
43n/a "checkout.updated",
53n/a "customer.created",
64n/a "customer.updated",
74n/a "customer.deleted",
83n/a "customer.state_changed",
93n/a "customer_seat.assigned",
102n/a "customer_seat.claimed",
113n/a "customer_seat.revoked",
124n/a "order.created",
136n/a "order.updated",
144n/a "order.paid",
151n/a "order.refunded",
162n/a "subscription.created",
172n/a "subscription.updated",
182n/a "subscription.active",
196n/a "subscription.canceled",
203n/a "subscription.uncanceled",
211n/a "subscription.revoked",
221n/a "refund.created",
232n/a "refund.updated",
245n/a "product.created",
253n/a "product.updated",
261n/a "benefit.created",
272n/a "benefit.updated",
281n/a "benefit_grant.created",
297n/a "benefit_grant.cycled",
302n/a "benefit_grant.updated",
312n/a "benefit_grant.revoked",
322n/a "organization.updated"
33898 ],
34907 "type": "string"
35898}
WebhookFormat3 of 3 keywords
119121{
219121 "enum": [
38n/a "raw",
48n/a "discord",
53n/a "slack"
619121 ],
722118 "type": "string"
819121}
Responses
codedescriptionhitsavg
200Webhook endpoint updated.36110ms
404Webhook endpoint not found.186ms
422Validation Error989ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized162ms
500Internal Server Error1572ms
400Bad Request86ms
Examples
Body: application/json
"polar_whs_ovyN6cPrTv56AApvzCaJno08SSmGJmgbWilb33N2JuK"WebhookEndpointUpdate.secret.examples[0]
"https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0"WebhookEndpointUpdate.url.examples[0]
Path Parameters
id2 / 2
#validinvalidschema
140011{
240011 "format": "uuid4",
3411n/a "type": "string"
440011}
Responses
codedescriptionhitsavg
200Webhook endpoint secret reset.3338ms
404Webhook endpoint not found.96ms
422Validation Error116ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized582ms
Path Parameters
id2 / 2
#validinvalidschema
134665{
234665 "format": "uuid4",
3411n/a "type": "string"
434665}
Responses
codedescriptionhitsavg
202Webhook event re-delivery scheduled.0never seen
404Webhook event not found.3107ms
422Validation Error655ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized362ms
770 unmatched requests Not counted in coverage above
MethodHostPathReasonCount
DELETE0.0.0.0:43193/v1/accountsmethod not documented1
DELETE0.0.0.0:43193/v1/accounts/searchmethod not documented1
DELETE0.0.0.0:43193/v1/accounts/{id}method not documented1
DELETE0.0.0.0:43193/v1/accounts/{id}/dashboard_linkmethod not documented1
DELETE0.0.0.0:43193/v1/accounts/{id}/onboarding_linkmethod not documented1
DELETE0.0.0.0:43193/v1/benefit-grants/method not documented1
DELETE0.0.0.0:43193/v1/benefits/method not documented1
DELETE0.0.0.0:43193/v1/benefits/{id}/grantsmethod not documented1
DELETE0.0.0.0:43193/v1/checkout-links/method not documented1
DELETE0.0.0.0:43193/v1/checkouts/method not documented1

... and 760 more groups