Schemathesis 4.29.4
API Coverage Report
2026-10-07 12:42:14
Operations
Operations called at least once
96.9% 222 of 229 called
Parameters
Tested with valid and invalid values
53.7% 274 of 510 covered
Keywords
Constraints tested both ways
83.1% 4543 of 5465 covered
Examples
Schema examples sent in tests
82.6% 285 of 345 used
Responses
Documented response codes hit
62.1% 383 of 616 received
Show
accounts 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100% #
Body10 of 10 keywords covered
application/json10 / 10
AccountCreateForOrganization
#validinvalidschema
147049{
248529 "properties": {
34999 "account_type": {
44999 "const": "stripe",
55035 "type": "string"
64999 },
748717 "country": {
848717 "$ref": "#/components/schemas/StripeAccountCountry"
948717 },
105076 "organization_id": {
115071 "format": "uuid",
125085 "type": "string"
135076 }
1448529 },
1549915 "required": [
165131 "organization_id",
175086 "account_type",
1850410 "country"
1949915 ],
205145 "type": "object"
2147049}
Referenced Components (1)3 of 3 keywords
StripeAccountCountry3 of 3 keywords
148717{
248717 "enum": [
318n/a "AL",
412n/a "AG",
524n/a "AR",
64n/a "AM",
71n/a "AU",
82n/a "AT",
95n/a "BH",
102n/a "BE",
1111n/a "BO",
123n/a "BA",
133n/a "BG",
145n/a "KH",
152n/a "CA",
163n/a "CL",
176n/a "CO",
181n/a "CR",
195n/a "HR",
202n/a "CY",
211n/a "CZ",
222n/a "CI",
239n/a "DK",
246n/a "DO",
251n/a "EC",
262n/a "EG",
274n/a "SV",
281n/a "EE",
293n/a "ET",
309n/a "FI",
317n/a "FR",
326n/a "GM",
333n/a "DE",
341n/a "GH",
352n/a "GR",
362n/a "GT",
372n/a "GY",
382n/a "HK",
392n/a "HU",
404n/a "IS",
412n/a "IN",
425n/a "ID",
432n/a "IE",
441n/a "IL",
451n/a "IT",
462n/a "JM",
474n/a "JP",
483n/a "JO",
493n/a "KE",
501n/a "KW",
511n/a "LV",
524n/a "LI",
531n/a "LT",
549n/a "LU",
553n/a "MO",
561n/a "MG",
573n/a "MY",
581n/a "MT",
595n/a "MU",
604n/a "MX",
614n/a "MD",
622n/a "MN",
631n/a "MA",
641n/a "NA",
653n/a "NL",
666n/a "NZ",
671n/a "NG",
684n/a "MK",
691n/a "NO",
702n/a "OM",
711n/a "PA",
721n/a "PY",
732n/a "PE",
745n/a "PH",
752n/a "PL",
765n/a "PT",
7711n/a "QA",
784n/a "RO",
791n/a "RW",
809n/a "SA",
812n/a "SN",
825n/a "RS",
835n/a "SG",
843n/a "SK",
853n/a "SI",
861n/a "ZA",
871n/a "KR",
881n/a "ES",
893n/a "LK",
902n/a "LC",
913n/a "SE",
924n/a "CH",
9311n/a "TZ",
945n/a "TH",
9514n/a "TT",
962n/a "TN",
979n/a "TR",
9849n/a "AE",
992n/a "GB",
1003n/a "US",
1013n/a "UY",
1024n/a "UZ",
1032n/a "VN",
1041n/a "DZ",
1051n/a "AO",
1063n/a "AZ",
1072n/a "BS",
1081n/a "BD",
1091n/a "BJ",
1102n/a "BT",
1112n/a "BW",
1123n/a "BN",
1133n/a "GA",
1149n/a "KZ",
1156n/a "LA",
1162n/a "MC",
1171n/a "MZ",
1182n/a "NE",
1193n/a "PK",
1204n/a "SM",
1214n/a "TW"
12248717 ],
1234995 "type": "string"
12448717}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error935ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error34471ms
404Not Found1196ms
400Bad Request708ms
401Unauthorized123ms
Query Parameters4 of 4 keywords covered
page2 / 2
#validinvalidschema
117965{
217927 "exclusiveMinimum": 0,
320638 "type": "integer"
417965}
limit2 / 2
123449{
223422 "exclusiveMinimum": 0,
325627 "type": "integer"
423449}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response3637ms
422Validation Error775ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized962ms
500Internal Server Error31371ms
Examples2 / 2 used
Query
1page
10limit
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13258{
23258 "format": "uuid",
3333n/a "type": "string"
43258}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error85ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3066ms
401Unauthorized192ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
16445{
26445 "format": "uuid",
3649n/a "type": "string"
46445}
Body34 of 34 keywords covered
application/json34 / 34
AccountUpdate
143262{
234657 "properties": {
336210 "billing_additional_info": {
436210 "anyOf": [
522350 {
622350 "type": "string"
722350 },
834032 {
934032 "type": "null"
1034032 }
1136210 ],
1236210 },
1333639 "billing_address": {
1433639 "anyOf": [
1528491 {
1628491 "$ref": "#/components/schemas/AddressInput"
1728491 },
1852323 {
1952323 "type": "null"
2052323 }
2133639 ],
2233639 },
2335910 "billing_name": {
2435910 "anyOf": [
2536333 {
2636333 "type": "string"
2736333 },
2832346 {
2932346 "type": "null"
3032346 }
3135910 ],
3235910 },
333624 "billing_notes": {
343624 "anyOf": [
3523343 {
3623343 "type": "string"
3723343 },
3833927 {
3933927 "type": "null"
4033927 }
413624 ],
423624 }
4334657 },
444895 "type": "object"
4543262}
Referenced Components (1)28 of 28 keywords
AddressInput28 of 28 keywords
128491{
228533 "properties": {
329210 "city": {
429210 "anyOf": [
512290 {
612290 "type": "string"
712290 },
828022 {
928022 "type": "null"
1028022 }
1129210 ],
1229210 },
133116 "country": {
143116 "enum": [
1513n/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",
412n/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",
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",
1402n/a "LI",
1416n/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",
1685n/a "MX",
1691n/a "MY",
1701n/a "MZ",
1711n/a "NA",
1721n/a "NC",
1731n/a "NE",
1741n/a "NF",
1753n/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",
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",
2021n/a "RW",
2031n/a "SA",
2041n/a "SB",
2051n/a "SC",
2061n/a "SD",
2072n/a "SE",
2083n/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",
2441n/a "UZ",
2451n/a "VA",
2461n/a "VC",
2471n/a "VE",
2481n/a "VG",
2492n/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"
2593116 ],
2603125 "type": "string",
2613116 },
2622954 "line1": {
2632954 "anyOf": [
26412287 {
26512287 "type": "string"
26612287 },
26728316 {
26828316 "type": "null"
26928316 }
2702954 ],
2712954 },
2722835 "line2": {
2732835 "anyOf": [
2742286 {
2752286 "type": "string"
2762286 },
2772817 {
2782817 "type": "null"
2792817 }
2802835 ],
2812835 },
2822925 "postal_code": {
2832925 "anyOf": [
28413284 {
28513284 "type": "string"
28613284 },
28727918 {
28827918 "type": "null"
28927918 }
2902925 ],
2912925 },
2922924 "state": {
2932924 "anyOf": [
2944292 {
2954292 "type": "string"
2964292 },
2972888 {
2982888 "type": "null"
2992888 }
3002924 ],
3012924 }
30228533 },
3033172 "required": [
3043172 "country"
3053172 ],
30631956 "type": "object"
30728491}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error1316ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found4256ms
500Internal Server Error5824ms
401Unauthorized23ms
400Bad Request8611ms
Examples3 / 3 used
Body: application/json
"US"AddressInput.country.examples[0]
"SE"AddressInput.country.examples[1]
"FR"AddressInput.country.examples[2]
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
133013{
233013 "format": "uuid",
3343n/a "type": "string"
433013}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error135ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2996ms
401Unauthorized312ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13175{
23175 "format": "uuid",
3322n/a "type": "string"
43175}
Query Parameters1 of 1 keywords covered
return_path1 / 1
1321n/a{
2321n/a "type": "string"
3321n/a}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error65ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2965ms
401Unauthorized202ms
auth 1 operation 0 covered 0 partial 1 uncovered 0 not measured — #
Expected Responses0 of 1 documented received
codedescriptionhitsavg
200Successful Response0never seen
benefit-grants 1 operation 0 covered 1 partial 0 uncovered 0 not measured 55% #
Query Parameters17 of 27 keywords covered
organization_id2 / 7
#validinvalidschema
17920{
27920 "anyOf": [
30792 {
400 "format": "uuid4",
50n/a "type": "string",
60792 },
77920 {
87920 "items": {
97920 "format": "uuid4",
10792n/a "type": "string",
117920 },
127920 "type": "array"
137920 },
140792 {
150792 "type": "null"
160792 }
177920 ],
187920}
customer_id4 / 7
124619{
224619 "anyOf": [
30265 {
400 "format": "uuid4",
50n/a "type": "string"
60265 },
724619 {
824619 "items": {
9597131 "format": "uuid4",
10728n/a "type": "string"
1124619 },
122650 "type": "array"
1324619 },
140265 {
150265 "type": "null"
160265 }
1724619 ],
1824619}
is_granted3 / 3
121012{
221012 "anyOf": [
319923 {
419923 "type": "boolean"
519923 },
611211 {
711211 "type": "null"
811211 }
921012 ],
1021012}
page2 / 2
132628{
23262 "exclusiveMinimum": 0,
332826 "type": "integer"
432628}
limit2 / 2
130536{
23052 "exclusiveMinimum": 0,
330734 "type": "integer"
430536}
sorting4 / 6
114327{
214327 "anyOf": [
314327 {
414327 "items": {
564344 "$ref": "#/components/schemas/BenefitGrantSortProperty"
614327 },
71700 "type": "array"
814327 },
90170 {
100170 "type": "null"
110170 }
1214327 ],
1314327}
Referenced Components (1)3 of 3 keywords
BenefitGrantSortProperty3 of 3 keywords
164344{
264344 "enum": [
374n/a "created_at",
4137n/a "-created_at",
5108n/a "granted_at",
6104n/a "-granted_at",
7123n/a "revoked_at",
897n/a "-revoked_at"
964344 ],
10668n/a "type": "string"
1164344}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response5668ms
422Validation Error748ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1322ms
500Internal Server Error201489ms
Examples3 / 5 used
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 86% #
Query Parameters21 of 40 keywords covered
organization_id2 / 7
#validinvalidschema
17740{
27740 "anyOf": [
30774 {
400 "format": "uuid4",
50n/a "type": "string",
60774 },
77740 {
87740 "items": {
97740 "format": "uuid4",
10774n/a "type": "string",
117740 },
127740 "type": "array"
137740 },
140774 {
150774 "type": "null"
160774 }
177740 ],
187740}
type4 / 7
120031{
220031 "anyOf": [
30231 {
40231 "$ref": "#/components/schemas/BenefitType"
50231 },
620031 {
720031 "items": {
854845 "$ref": "#/components/schemas/BenefitType"
920031 },
102310 "type": "array"
1120031 },
120231 {
130231 "type": "null"
140231 }
1520031 ],
1620031}
Referenced Components (1)3 of 3 keywords
BenefitType3 of 3 keywords
1548276{
2548276 "enum": [
3144n/a "custom",
487n/a "discord",
579n/a "github_repository",
673n/a "downloadables",
780n/a "license_keys",
885n/a "meter_credit"
9548276 ],
10569n/a "type": "string"
11548276}
query3 / 3
1211n/a{
2211n/a "anyOf": [
3203n/a {
4203n/a "type": "string"
5203n/a },
68203 {
78203 "type": "null"
88203 }
9211n/a ],
10211n/a}
page2 / 2
134121{
23413 "exclusiveMinimum": 0,
334418 "type": "integer"
434121}
limit2 / 2
137226{
23722 "exclusiveMinimum": 0,
337424 "type": "integer"
437226}
sorting4 / 6
116715{
216715 "anyOf": [
316715 {
416715 "items": {
562017 "$ref": "#/components/schemas/BenefitSortProperty"
616715 },
71820 "type": "array"
816715 },
90182 {
100182 "type": "null"
110182 }
1216715 ],
1316715}
Referenced Components (1)3 of 3 keywords
BenefitSortProperty3 of 3 keywords
162017{
262017 "enum": [
3105n/a "created_at",
4139n/a "-created_at",
576n/a "description",
6103n/a "-description",
7131n/a "type",
866n/a "-type"
962017 ],
10622n/a "type": "string"
1162017}
metadata4 / 13
MetadataQuery
11180{
21180 "anyOf": [
31180 {
41180 "additionalProperties": {
53100 "anyOf": [
6155155 {
7155155 "type": "string"
8155155 },
90310 {
100310 "type": "integer"
110310 },
120310 {
130310 "type": "boolean"
140310 },
15155155 {
161550 "items": {
1712850 "type": "string"
181550 },
19155155 "type": "array"
20155155 },
210310 {
220155 "items": {
2301285 "type": "integer"
240155 },
25155155 "type": "array"
260310 },
270310 {
280155 "items": {
2901285 "type": "boolean"
300155 },
31155155 "type": "array"
320310 }
333100 ]
341180 },
351180 "type": "object"
361180 },
370118 {
380118 "type": "null"
390118 }
401180 ],
411180}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response5909ms
422Validation Error685ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized972ms
500Internal Server Error191430ms
Examples3 / 5 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-created_at" ]sorting
Body197 of 219 keywords covered
application/json197 / 219
BenefitCreate
#validinvalidschema
1562678{
2562678 "oneOf": [
31411099 {
41411099 "$ref": "#/components/schemas/BenefitCustomCreate"
51411099 },
6881152 {
7881152 "$ref": "#/components/schemas/BenefitDiscordCreate"
8881152 },
9751165 {
10751165 "$ref": "#/components/schemas/BenefitGitHubRepositoryCreate"
11751165 },
12641176 {
13641176 "$ref": "#/components/schemas/BenefitDownloadablesCreate"
14641176 },
151031137 {
161031137 "$ref": "#/components/schemas/BenefitLicenseKeysCreate"
171031137 },
18911149 {
19911149 "$ref": "#/components/schemas/BenefitMeterCreditCreate"
20911149 }
21562678 ]
22562678}
Referenced Components (14)236 of 258 keywords
BenefitCustomCreate25 of 28 keywords
11411099{
21571073 "properties": {
3112284 "description": {
4113412 "maxLength": 42,
5113412 "minLength": 3,
6114660 "type": "string"
7112284 },
870489 "metadata": {
97627 "additionalProperties": {
1026542 "anyOf": [
1180227 {
121070 "maxLength": 500,
138027 "minLength": 1,
14107200 "type": "string"
1580227 },
1668239 {
1768239 "type": "integer"
1868239 },
1991216 {
2091216 "type": "number"
2191216 },
2294213 {
2394213 "type": "boolean"
2494213 }
2526542 ]
267627 },
277310 "maxProperties": 50,
287924 "propertyNames": {
2929512 "maxLength": 40,
3029512 "minLength": 1
317924 },
3273162 "type": "object"
3370489 },
34104648 "organization_id": {
35104648 "anyOf": [
36103460 {
3710340 "format": "uuid4",
38103460 "type": "string",
39103460 },
40121082 {
41121082 "type": "null"
42121082 }
43104648 ],
44104648 },
45113868 "properties": {
46113868 "$ref": "#/components/schemas/BenefitCustomCreateProperties"
47113868 },
481991019 "type": {
491991019 "const": "custom",
50114870 "type": "string"
511991019 }
521571073 },
53118248 "required": [
54121812 "type",
55120624 "description",
56120624 "properties"
57118248 ],
58123010 "type": "object"
591411099}
BenefitCustomCreateProperties10 of 10 keywords
1113868{
2938 "properties": {
3938 "note": {
4938 "anyOf": [
5938 {
6938 "anyOf": [
71289 {
81289 "type": "string"
91289 },
108120 {
118120 "type": "null"
128120 }
13938 ],
14938 },
158120 {
168120 "type": "null"
178120 }
18938 ],
19938 }
20938 },
21114660 "type": "object"
22113868}
BenefitDiscordCreate25 of 28 keywords
1881152{
2941136 "properties": {
3112284 "description": {
4113412 "maxLength": 42,
5113412 "minLength": 3,
6114660 "type": "string"
7112284 },
870489 "metadata": {
97627 "additionalProperties": {
1026542 "anyOf": [
1180227 {
121070 "maxLength": 500,
138027 "minLength": 1,
14107200 "type": "string"
1580227 },
1668239 {
1768239 "type": "integer"
1868239 },
1991216 {
2091216 "type": "number"
2191216 },
2294213 {
2394213 "type": "boolean"
2494213 }
2526542 ]
267627 },
277310 "maxProperties": 50,
287924 "propertyNames": {
2929512 "maxLength": 40,
3029512 "minLength": 1
317924 },
3273162 "type": "object"
3370489 },
34104648 "organization_id": {
35104648 "anyOf": [
36103460 {
3710340 "format": "uuid4",
38103460 "type": "string",
39103460 },
40121082 {
41121082 "type": "null"
42121082 }
43104648 ],
44104648 },
451401066 "properties": {
461401066 "$ref": "#/components/schemas/BenefitDiscordCreateProperties"
471401066 },
481741044 "type": {
491741044 "const": "discord",
50114870 "type": "string"
511741044 }
52941136 },
53118248 "required": [
54121812 "type",
55120624 "description",
56120624 "properties"
57118248 ],
58123010 "type": "object"
59881152}
BenefitDiscordCreateProperties8 of 8 keywords
11401066{
214630 "properties": {
316410 "guild_token": {
416410 "type": "string"
516410 },
616410 "kick_member": {
716410 "type": "boolean"
816410 },
916410 "role_id": {
1016410 "type": "string"
1116410 }
1214630 },
13170976 "required": [
14174972 "guild_token",
15174972 "role_id",
16174972 "kick_member"
17170976 ],
18114660 "type": "object"
191401066}
BenefitDownloadablesCreate25 of 28 keywords
1641176{
2701160 "properties": {
3112284 "description": {
4113412 "maxLength": 42,
5113412 "minLength": 3,
6114660 "type": "string"
7112284 },
870489 "metadata": {
97627 "additionalProperties": {
1026542 "anyOf": [
1180227 {
121070 "maxLength": 500,
138027 "minLength": 1,
14107200 "type": "string"
1580227 },
1668239 {
1768239 "type": "integer"
1868239 },
1991216 {
2091216 "type": "number"
2191216 },
2294213 {
2394213 "type": "boolean"
2494213 }
2526542 ]
267627 },
277310 "maxProperties": 50,
287924 "propertyNames": {
2929512 "maxLength": 40,
3029512 "minLength": 1
317924 },
3273162 "type": "object"
3370489 },
34104648 "organization_id": {
35104648 "anyOf": [
36103460 {
3710340 "format": "uuid4",
38103460 "type": "string",
39103460 },
40121082 {
41121082 "type": "null"
42121082 }
43104648 ],
44104648 },
451161090 "properties": {
461161090 "$ref": "#/components/schemas/BenefitDownloadablesCreateProperties"
471161090 },
481481070 "type": {
491481070 "const": "downloadables",
50114870 "type": "string"
511481070 }
52701160 },
53118248 "required": [
54121812 "type",
55120624 "description",
56120624 "properties"
57118248 ],
58123010 "type": "object"
59641176}
BenefitDownloadablesCreateProperties9 of 12 keywords
11161090{
211832 "properties": {
310410 "archived": {
490 "additionalProperties": {
5130 "type": "boolean"
690 },
790 "propertyNames": {
8130 "format": "uuid4"
990 },
1010410 "type": "object"
1110410 },
1212622 "files": {
1312810 "items": {
142840 "format": "uuid4",
1528410 "type": "string"
1612810 },
171362 "minItems": 1,
1813810 "type": "array"
1912622 }
2011832 },
21148998 "required": [
22148998 "files"
23148998 ],
24114660 "type": "object"
251161090}
BenefitGitHubRepositoryCreate25 of 28 keywords
1751165{
2811149 "properties": {
3112284 "description": {
4113412 "maxLength": 42,
5113412 "minLength": 3,
6114660 "type": "string"
7112284 },
870489 "metadata": {
97627 "additionalProperties": {
1026542 "anyOf": [
1180227 {
121070 "maxLength": 500,
138027 "minLength": 1,
14107200 "type": "string"
1580227 },
1668239 {
1768239 "type": "integer"
1868239 },
1991216 {
2091216 "type": "number"
2191216 },
2294213 {
2394213 "type": "boolean"
2494213 }
2526542 ]
267627 },
277310 "maxProperties": 50,
287924 "propertyNames": {
2929512 "maxLength": 40,
3029512 "minLength": 1
317924 },
3273162 "type": "object"
3370489 },
34104648 "organization_id": {
35104648 "anyOf": [
36103460 {
3710340 "format": "uuid4",
38103460 "type": "string",
39103460 },
40121082 {
41121082 "type": "null"
42121082 }
43104648 ],
44104648 },
451301076 "properties": {
461301076 "$ref": "#/components/schemas/BenefitGitHubRepositoryCreateProperties"
471301076 },
481671051 "type": {
491671051 "const": "github_repository",
50114870 "type": "string"
511671051 }
52811149 },
53118248 "required": [
54121812 "type",
55120624 "description",
56120624 "properties"
57118248 ],
58123010 "type": "object"
59751165}
BenefitGitHubRepositoryCreateProperties10 of 10 keywords
11301076{
213732 "properties": {
315512 "permission": {
415512 "enum": [
5106n/a "pull",
615n/a "triage",
76n/a "push",
817n/a "maintain",
911n/a "admin"
1015512 ],
1115710 "type": "string"
1215512 },
1315710 "repository_name": {
1415710 "type": "string"
1515710 },
1615610 "repository_owner": {
1715610 "type": "string"
1815610 }
1913732 },
20162984 "required": [
21166980 "repository_owner",
22167979 "repository_name",
23167979 "permission"
24162984 ],
25114660 "type": "object"
261301076}
BenefitLicenseKeyActivationCreateProperties9 of 9 keywords
123195{
22727 "properties": {
34110 "enable_customer_admin": {
44110 "type": "boolean"
54110 },
63517 "limit": {
7392 "exclusiveMinimum": 0.0,
8392 "maximum": 50.0,
93913 "type": "integer"
103517 }
112727 },
12497 "required": [
13524 "limit",
14515 "enable_customer_admin"
15497 ],
1656162 "type": "object"
1723195}
BenefitLicenseKeyExpirationProperties10 of 10 keywords
122206{
22626 "properties": {
33812 "timeframe": {
43812 "enum": [
527n/a "year",
64n/a "month",
77n/a "day"
83812 ],
94010 "type": "string"
103812 },
113614 "ttl": {
12382 "exclusiveMinimum": 0.0,
133812 "type": "integer"
143614 }
152626 },
164813 "required": [
175011 "ttl",
185011 "timeframe"
194813 ],
2061167 "type": "object"
2122206}
BenefitLicenseKeysCreate25 of 28 keywords
11031137{
21191111 "properties": {
3112284 "description": {
4113412 "maxLength": 42,
5113412 "minLength": 3,
6114660 "type": "string"
7112284 },
870489 "metadata": {
97627 "additionalProperties": {
1026542 "anyOf": [
1180227 {
121070 "maxLength": 500,
138027 "minLength": 1,
14107200 "type": "string"
1580227 },
1668239 {
1768239 "type": "integer"
1868239 },
1991216 {
2091216 "type": "number"
2191216 },
2294213 {
2394213 "type": "boolean"
2494213 }
2526542 ]
267627 },
277310 "maxProperties": 50,
287924 "propertyNames": {
2929512 "maxLength": 40,
3029512 "minLength": 1
317924 },
3273162 "type": "object"
3370489 },
34104648 "organization_id": {
35104648 "anyOf": [
36103460 {
3710340 "format": "uuid4",
38103460 "type": "string",
39103460 },
40121082 {
41121082 "type": "null"
42121082 }
43104648 ],
44104648 },
451038168 "properties": {
461038168 "$ref": "#/components/schemas/BenefitLicenseKeysCreateProperties"
471038168 },
48261957 "type": {
49261957 "const": "license_keys",
50114870 "type": "string"
51261957 }
521191111 },
53118248 "required": [
54121812 "type",
55120624 "description",
56120624 "properties"
57118248 ],
58123010 "type": "object"
591031137}
BenefitLicenseKeysCreateProperties20 of 20 keywords
11038168{
2134108 "properties": {
317741 "activations": {
417741 "anyOf": [
523195 {
623195 "$ref": "#/components/schemas/BenefitLicenseKeyActivationCreateProperties"
723195 },
815464 {
915464 "type": "null"
1015464 }
1117741 ]
1217741 },
1318147 "expires": {
1418147 "anyOf": [
1522206 {
1622206 "$ref": "#/components/schemas/BenefitLicenseKeyExpirationProperties"
1722206 },
1815969 {
1915969 "type": "null"
2015969 }
2118147 ]
2218147 },
2319712 "limit_usage": {
2419712 "anyOf": [
2518821 {
261902 "exclusiveMinimum": 0.0,
2719019 "type": "integer"
2818821 },
299200 {
309200 "type": "null"
319200 }
3219712 ],
3319712 },
342088 "prefix": {
352088 "anyOf": [
3615201 {
3715201 "type": "string"
3815201 },
3919323 {
4019323 "type": "null"
4119323 }
422088 ],
432088 }
44134108 },
45114660 "type": "object"
461038168}
BenefitMeterCreditCreate25 of 28 keywords
1911149{
2971133 "properties": {
3112284 "description": {
4113412 "maxLength": 42,
5113412 "minLength": 3,
6114660 "type": "string"
7112284 },
870489 "metadata": {
97627 "additionalProperties": {
1026542 "anyOf": [
1180227 {
121070 "maxLength": 500,
138027 "minLength": 1,
14107200 "type": "string"
1580227 },
1668239 {
1768239 "type": "integer"
1868239 },
1991216 {
2091216 "type": "number"
2191216 },
2294213 {
2394213 "type": "boolean"
2494213 }
2526542 ]
267627 },
277310 "maxProperties": 50,
287924 "propertyNames": {
2929512 "maxLength": 40,
3029512 "minLength": 1
317924 },
3273162 "type": "object"
3370489 },
34104648 "organization_id": {
35104648 "anyOf": [
36103460 {
3710340 "format": "uuid4",
38103460 "type": "string",
39103460 },
40121082 {
41121082 "type": "null"
42121082 }
43104648 ],
44104648 },
451451061 "properties": {
461451061 "$ref": "#/components/schemas/BenefitMeterCreditCreateProperties"
471451061 },
481851033 "type": {
491851033 "const": "meter_credit",
50114870 "type": "string"
511851033 }
52971133 },
53118248 "required": [
54121812 "type",
55120624 "description",
56120624 "properties"
57118248 ],
58123010 "type": "object"
59911149}
BenefitMeterCreditCreateProperties10 of 11 keywords
11451061{
215136 "properties": {
317510 "meter_id": {
41750 "format": "uuid4",
517510 "type": "string"
617510 },
717510 "rollover": {
817510 "type": "boolean"
917510 },
1016916 "units": {
111732 "exclusiveMinimum": 0.0,
121732 "maximum": 2147483647.0,
1317312 "type": "integer"
1416916 }
1515136 },
16181965 "required": [
17185961 "units",
18185961 "rollover",
19185961 "meter_id"
20181965 ],
21114660 "type": "object"
221451061}
Responses2 of 2 documented received
codedescriptionhitsavg
201Benefit created.18816ms
422Validation Error9815ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized422ms
500Internal Server Error4751ms
400Bad Request65ms
Examples9 / 9 used
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 Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
1420{
2420 "format": "uuid4",
342n/a "type": "string",
4420}
Responses2 of 4 documented received
codedescriptionhitsavg
204Benefit deleted.2718ms
403This benefit is not deletable.0never seen
404Benefit not found.126ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized34ms
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13080{
23080 "format": "uuid4",
3308n/a "type": "string",
43080}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response2715ms
404Benefit not found.166ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized212ms
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
19560{
29560 "format": "uuid4",
3956n/a "type": "string",
49560}
Body204 of 220 keywords covered
application/json204 / 220
1418508{
2418508 "anyOf": [
3181745 {
4181745 "$ref": "#/components/schemas/BenefitCustomUpdate"
5181745 },
636890 {
736890 "$ref": "#/components/schemas/BenefitDiscordUpdate"
836890 },
949877 {
1049877 "$ref": "#/components/schemas/BenefitGitHubRepositoryUpdate"
1149877 },
1234892 {
1334892 "$ref": "#/components/schemas/BenefitDownloadablesUpdate"
1434892 },
1575851 {
1675851 "$ref": "#/components/schemas/BenefitLicenseKeysUpdate"
1775851 },
1843883 {
1943883 "$ref": "#/components/schemas/BenefitMeterCreditUpdate"
2043883 }
21418508 ],
22418508}
Referenced Components (14)250 of 266 keywords
BenefitCustomProperties12 of 12 keywords
14659{
248 "properties": {
348 "note": {
448 "anyOf": [
548 {
648 "anyOf": [
7210 {
8210 "type": "string"
9210 },
10210 {
11210 "type": "null"
12210 }
1348 ],
1448 },
15210 {
16210 "type": "null"
17210 }
1848 ],
1948 }
2048 },
2112346 "required": [
2212346 "note"
2312346 ],
24358305 "type": "object"
254659}
BenefitCustomUpdate27 of 29 keywords
1181745{
2183726 "properties": {
360176 "description": {
460176 "anyOf": [
558196 {
659313 "maxLength": 42,
759412 "minLength": 3,
860671 "type": "string"
958196 },
1020657 {
1120657 "type": "null"
1220657 }
1360176 ],
1460176 },
1559885 "metadata": {
162025 "additionalProperties": {
175925 "anyOf": [
182064 {
19440 "maxLength": 500,
202024 "minLength": 1,
214440 "type": "string"
222064 },
231965 {
241965 "type": "integer"
251965 },
262262 {
272262 "type": "number"
282262 },
291767 {
301767 "type": "boolean"
311767 }
325925 ]
332025 },
346230 "maxProperties": 50,
352124 "propertyNames": {
367212 "maxLength": 40,
377212 "minLength": 1
382124 },
3962360 "type": "object"
4059885 },
41258405 "properties": {
42258405 "anyOf": [
434659 {
444659 "$ref": "#/components/schemas/BenefitCustomProperties"
454659 },
46254409 {
47254409 "type": "null"
48254409 }
49258405 ]
50258405 },
51225682 "type": {
52225682 "const": "custom",
5389710 "type": "string"
54225682 }
55183726 },
569073 "required": [
579073 "type"
589073 ],
5991016 "type": "object"
60181745}
BenefitDiscordCreateProperties8 of 8 keywords
14659{
21030 "properties": {
32810 "guild_token": {
42810 "type": "string"
52810 },
62810 "kick_member": {
72810 "type": "boolean"
82810 },
92810 "role_id": {
102810 "type": "string"
112810 }
121030 },
1334324 "required": [
1438320 "guild_token",
1538320 "role_id",
1638320 "kick_member"
1734324 ],
18358305 "type": "object"
194659}
BenefitDiscordUpdate27 of 29 keywords
136890{
238871 "properties": {
360176 "description": {
460176 "anyOf": [
558196 {
659313 "maxLength": 42,
759412 "minLength": 3,
860671 "type": "string"
958196 },
1020657 {
1120657 "type": "null"
1220657 }
1360176 ],
1460176 },
1559885 "metadata": {
162025 "additionalProperties": {
175925 "anyOf": [
182064 {
19440 "maxLength": 500,
202024 "minLength": 1,
214440 "type": "string"
222064 },
231965 {
241965 "type": "integer"
251965 },
262262 {
272262 "type": "number"
282262 },
291767 {
301767 "type": "boolean"
311767 }
325925 ]
332025 },
346230 "maxProperties": 50,
352124 "propertyNames": {
367212 "maxLength": 40,
377212 "minLength": 1
382124 },
3962360 "type": "object"
4059885 },
41258405 "properties": {
42258405 "anyOf": [
434659 {
444659 "$ref": "#/components/schemas/BenefitDiscordCreateProperties"
454659 },
46254409 {
47254409 "type": "null"
48254409 }
49258405 ]
50258405 },
51108799 "type": {
52108799 "const": "discord",
5389710 "type": "string"
54108799 }
5538871 },
569073 "required": [
579073 "type"
589073 ],
5991016 "type": "object"
6036890}
BenefitDownloadablesCreateProperties9 of 12 keywords
16657{
2832 "properties": {
32810 "archived": {
400 "additionalProperties": {
500 "type": "boolean"
600 },
700 "propertyNames": {
800 "format": "uuid4"
900 },
102810 "type": "object"
112810 },
121622 "files": {
131810 "items": {
14180 "format": "uuid4",
151810 "type": "string"
161810 },
17262 "minItems": 1,
182810 "type": "array"
191622 }
20832 },
2138320 "required": [
2238320 "files"
2338320 ],
24358305 "type": "object"
256657}
BenefitDownloadablesUpdate27 of 29 keywords
134892{
236873 "properties": {
360176 "description": {
460176 "anyOf": [
558196 {
659313 "maxLength": 42,
759412 "minLength": 3,
860671 "type": "string"
958196 },
1020657 {
1120657 "type": "null"
1220657 }
1360176 ],
1460176 },
1559885 "metadata": {
162025 "additionalProperties": {
175925 "anyOf": [
182064 {
19440 "maxLength": 500,
202024 "minLength": 1,
214440 "type": "string"
222064 },
231965 {
241965 "type": "integer"
251965 },
262262 {
272262 "type": "number"
282262 },
291767 {
301767 "type": "boolean"
311767 }
325925 ]
332025 },
346230 "maxProperties": 50,
352124 "propertyNames": {
367212 "maxLength": 40,
377212 "minLength": 1
382124 },
3962360 "type": "object"
4059885 },
41260403 "properties": {
42260403 "anyOf": [
436657 {
446657 "$ref": "#/components/schemas/BenefitDownloadablesCreateProperties"
456657 },
46254409 {
47254409 "type": "null"
48254409 }
49260403 ]
50260403 },
51105802 "type": {
52105802 "const": "downloadables",
5389710 "type": "string"
54105802 }
5536873 },
569073 "required": [
579073 "type"
589073 ],
5991016 "type": "object"
6034892}
BenefitGitHubRepositoryCreateProperties10 of 10 keywords
121642{
22732 "properties": {
34512 "permission": {
44512 "enum": [
529n/a "pull",
62n/a "triage",
79n/a "push",
83n/a "maintain",
92n/a "admin"
104512 ],
114710 "type": "string"
124512 },
134710 "repository_name": {
144710 "type": "string"
154710 },
164710 "repository_owner": {
174710 "type": "string"
184710 }
192732 },
2053305 "required": [
2157301 "repository_owner",
2257301 "repository_name",
2357301 "permission"
2453305 ],
25358305 "type": "object"
2621642}
BenefitGitHubRepositoryUpdate27 of 29 keywords
149877{
251858 "properties": {
360176 "description": {
460176 "anyOf": [
558196 {
659313 "maxLength": 42,
759412 "minLength": 3,
860671 "type": "string"
958196 },
1020657 {
1120657 "type": "null"
1220657 }
1360176 ],
1460176 },
1559885 "metadata": {
162025 "additionalProperties": {
175925 "anyOf": [
182064 {
19440 "maxLength": 500,
202024 "minLength": 1,
214440 "type": "string"
222064 },
231965 {
241965 "type": "integer"
251965 },
262262 {
272262 "type": "number"
282262 },
291767 {
301767 "type": "boolean"
311767 }
325925 ]
332025 },
346230 "maxProperties": 50,
352124 "propertyNames": {
367212 "maxLength": 40,
377212 "minLength": 1
382124 },
3962360 "type": "object"
4059885 },
41275388 "properties": {
42275388 "anyOf": [
4321642 {
4421642 "$ref": "#/components/schemas/BenefitGitHubRepositoryCreateProperties"
4521642 },
46254409 {
47254409 "type": "null"
48254409 }
49275388 ]
50275388 },
51126781 "type": {
52126781 "const": "github_repository",
5389710 "type": "string"
54126781 }
5551858 },
569073 "required": [
579073 "type"
589073 ],
5991016 "type": "object"
6049877}
BenefitLicenseKeyActivationCreateProperties9 of 9 keywords
110123{
21426 "properties": {
32810 "enable_customer_admin": {
42810 "type": "boolean"
52810 },
62216 "limit": {
7262 "exclusiveMinimum": 0.0,
8262 "maximum": 50.0,
92612 "type": "integer"
102216 }
111426 },
12366 "required": [
13384 "limit",
14384 "enable_customer_admin"
15366 ],
164291 "type": "object"
1710123}
BenefitLicenseKeyExpirationProperties10 of 10 keywords
18126{
21226 "properties": {
32412 "timeframe": {
42412 "enum": [
520n/a "year",
62n/a "month",
72n/a "day"
82412 ],
92610 "type": "string"
102412 },
112214 "ttl": {
12242 "exclusiveMinimum": 0.0,
132412 "type": "integer"
142214 }
151226 },
16346 "required": [
17364 "ttl",
18364 "timeframe"
19346 ],
204094 "type": "object"
218126}
BenefitLicenseKeysCreateProperties20 of 20 keywords
1258405{
240100 "properties": {
39340 "activations": {
49340 "anyOf": [
510123 {
610123 "$ref": "#/components/schemas/BenefitLicenseKeyActivationCreateProperties"
710123 },
88350 {
98350 "type": "null"
108350 }
119340 ]
129340 },
139440 "expires": {
149440 "anyOf": [
158126 {
168126 "$ref": "#/components/schemas/BenefitLicenseKeyExpirationProperties"
178126 },
188648 {
198648 "type": "null"
208648 }
219440 ]
229440 },
2311912 "limit_usage": {
2411912 "anyOf": [
2511714 {
261192 "exclusiveMinimum": 0.0,
2711912 "type": "integer"
2811714 },
292129 {
302129 "type": "null"
312129 }
3211912 ],
3311912 },
341208 "prefix": {
351208 "anyOf": [
362126 {
372126 "type": "string"
382126 },
3911810 {
4011810 "type": "null"
4111810 }
421208 ],
431208 }
4440100 },
45358305 "type": "object"
46258405}
BenefitLicenseKeysUpdate27 of 29 keywords
175851{
277832 "properties": {
360176 "description": {
460176 "anyOf": [
558196 {
659313 "maxLength": 42,
759412 "minLength": 3,
860671 "type": "string"
958196 },
1020657 {
1120657 "type": "null"
1220657 }
1360176 ],
1460176 },
1559885 "metadata": {
162025 "additionalProperties": {
175925 "anyOf": [
182064 {
19440 "maxLength": 500,
202024 "minLength": 1,
214440 "type": "string"
222064 },
231965 {
241965 "type": "integer"
251965 },
262262 {
272262 "type": "number"
282262 },
291767 {
301767 "type": "boolean"
311767 }
325925 ]
332025 },
346230 "maxProperties": 50,
352124 "propertyNames": {
367212 "maxLength": 40,
377212 "minLength": 1
382124 },
3962360 "type": "object"
4059885 },
41512151 "properties": {
42512151 "anyOf": [
43258405 {
44258405 "$ref": "#/components/schemas/BenefitLicenseKeysCreateProperties"
45258405 },
46254409 {
47254409 "type": "null"
48254409 }
49512151 ]
50512151 },
51209698 "type": {
52209698 "const": "license_keys",
5389710 "type": "string"
54209698 }
5577832 },
569073 "required": [
579073 "type"
589073 ],
5991016 "type": "object"
6075851}
BenefitMeterCreditCreateProperties10 of 11 keywords
110653{
21636 "properties": {
34010 "meter_id": {
4400 "format": "uuid4",
54010 "type": "string"
64010 },
74010 "rollover": {
84010 "type": "boolean"
94010 },
103416 "units": {
11382 "exclusiveMinimum": 0.0,
12382 "maximum": 2147483647.0,
133812 "type": "integer"
143416 }
151636 },
1646312 "required": [
1750308 "units",
1850308 "rollover",
1950308 "meter_id"
2046312 ],
21358305 "type": "object"
2210653}
BenefitMeterCreditUpdate27 of 29 keywords
143883{
245864 "properties": {
360176 "description": {
460176 "anyOf": [
558196 {
659313 "maxLength": 42,
759412 "minLength": 3,
860671 "type": "string"
958196 },
1020657 {
1120657 "type": "null"
1220657 }
1360176 ],
1460176 },
1559885 "metadata": {
162025 "additionalProperties": {
175925 "anyOf": [
182064 {
19440 "maxLength": 500,
202024 "minLength": 1,
214440 "type": "string"
222064 },
231965 {
241965 "type": "integer"
251965 },
262262 {
272262 "type": "number"
282262 },
291767 {
301767 "type": "boolean"
311767 }
325925 ]
332025 },
346230 "maxProperties": 50,
352124 "propertyNames": {
367212 "maxLength": 40,
377212 "minLength": 1
382124 },
3962360 "type": "object"
4059885 },
41264399 "properties": {
42264399 "anyOf": [
4310653 {
4410653 "$ref": "#/components/schemas/BenefitMeterCreditCreateProperties"
4510653 },
46254409 {
47254409 "type": "null"
48254409 }
49264399 ]
50264399 },
51122785 "type": {
52122785 "const": "meter_credit",
5389710 "type": "string"
54122785 }
5545864 },
569073 "required": [
579073 "type"
589073 ],
5991016 "type": "object"
6043883}
Responses3 of 3 documented received
codedescriptionhitsavg
200Benefit updated.10518ms
404Benefit not found.2126ms
422Validation Error6176ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized164ms
500Internal Server Error1824ms
400Bad Request57ms
Examples3 / 3 used
Body: application/json
"private_repo"BenefitGitHubRepositoryCreateProperties.repository_name.examples[0]
"polarsource"BenefitGitHubRepositoryCreateProperties.repository_owner.examples[0]
{}BenefitDownloadablesCreateProperties.archived
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
14480{
24480 "format": "uuid4",
3448n/a "type": "string",
44480}
Query Parameters11 of 14 keywords covered
is_granted3 / 3
16711{
26711 "anyOf": [
36315 {
46315 "type": "boolean"
56315 },
6474 {
7474 "type": "null"
8474 }
96711 ],
106711}
customer_id4 / 7
18110{
28110 "anyOf": [
3091 {
400 "format": "uuid4",
50n/a "type": "string"
6091 },
78110 {
88110 "items": {
91299 "format": "uuid4",
10138n/a "type": "string"
118110 },
12910 "type": "array"
138110 },
14091 {
15091 "type": "null"
16091 }
178110 ],
188110}
page2 / 2
19216{
2924 "exclusiveMinimum": 0,
39612 "type": "integer"
49216}
limit2 / 2
19021{
2904 "exclusiveMinimum": 0,
39417 "type": "integer"
49021}
Responses3 of 3 documented received
codedescriptionhitsavg
200Successful Response3277ms
404Benefit not found.586ms
422Validation Error485ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized153ms
Examples2 / 2 used
Query
1page
10limit
checkouts 8 operations 1 covered 7 partial 0 uncovered 0 not measured 84% #
Query Parameters23 of 41 keywords covered
organization_id2 / 7
#validinvalidschema
17160{
27160 "anyOf": [
30716 {
400 "format": "uuid4",
50n/a "type": "string",
60716 },
77160 {
87160 "items": {
97160 "format": "uuid4",
10716n/a "type": "string",
117160 },
127160 "type": "array"
137160 },
140716 {
150716 "type": "null"
160716 }
177160 ],
187160}
product_id3 / 7
15874{
25874 "anyOf": [
30591 {
400 "format": "uuid4",
50n/a "type": "string",
60591 },
75874 {
85874 "items": {
96100 "format": "uuid4",
10610n/a "type": "string",
115874 },
125910 "type": "array"
135874 },
140591 {
150591 "type": "null"
160591 }
175874 ],
185874}
customer_id3 / 7
12354{
22354 "anyOf": [
30239 {
400 "format": "uuid4",
50n/a "type": "string"
60239 },
72354 {
82354 "items": {
94980 "format": "uuid4",
10498n/a "type": "string"
112354 },
122390 "type": "array"
132354 },
140239 {
150239 "type": "null"
160239 }
172354 ],
182354}
status4 / 7
118112{
218112 "anyOf": [
30193 {
40193 "$ref": "#/components/schemas/CheckoutStatus"
50193 },
618112 {
718112 "items": {
842514 "$ref": "#/components/schemas/CheckoutStatus"
918112 },
101930 "type": "array"
1118112 },
120193 {
130193 "type": "null"
140193 }
1518112 ],
1618112}
Referenced Components (1)3 of 3 keywords
CheckoutStatus3 of 3 keywords
1425207{
2425207 "enum": [
3111n/a "open",
475n/a "expired",
574n/a "confirmed",
682n/a "succeeded",
783n/a "failed"
8425207 ],
9427n/a "type": "string"
10425207}
query3 / 3
1170n/a{
2170n/a "anyOf": [
3168n/a {
4168n/a "type": "string"
5168n/a },
62168 {
72168 "type": "null"
82168 }
9170n/a ],
10170n/a}
page2 / 2
128623{
22862 "exclusiveMinimum": 0,
328821 "type": "integer"
428623}
limit2 / 2
129826{
22982 "exclusiveMinimum": 0,
330024 "type": "integer"
429826}
sorting4 / 6
114912{
214912 "anyOf": [
314912 {
414912 "items": {
556714 "$ref": "#/components/schemas/CheckoutSortProperty"
614912 },
71610 "type": "array"
814912 },
90161 {
100161 "type": "null"
110161 }
1214912 ],
1314912}
Referenced Components (1)3 of 3 keywords
CheckoutSortProperty3 of 3 keywords
156714{
256714 "enum": [
389n/a "created_at",
4125n/a "-created_at",
593n/a "expires_at",
685n/a "-expires_at",
769n/a "status",
8106n/a "-status"
956714 ],
10569n/a "type": "string"
1156714}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response55920ms
422Validation Error565ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized892ms
500Internal Server Error121596ms
Examples3 / 5 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-created_at" ]sorting
Body171 of 227 keywords covered
application/json171 / 227
CheckoutCreate
#validinvalidschema
11093573{
21093573 "$ref": "#/components/schemas/CheckoutProductsCreate"
31093573}
Referenced Components (10)216 of 279 keywords
AddressInput28 of 28 keywords
1608699{
261178 "properties": {
365112 "city": {
465112 "anyOf": [
515648 {
615648 "type": "string"
715648 },
863627 {
963627 "type": "null"
1063627 }
1165112 ],
1265112 },
1366818 "country": {
1466818 "enum": [
155n/a "AD",
162n/a "AE",
172n/a "AF",
182n/a "AG",
193n/a "AI",
203n/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",
523n/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",
703n/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",
953n/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",
1324n/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",
1443n/a "LT",
1452n/a "LU",
1462n/a "LV",
1472n/a "LY",
1482n/a "MA",
1493n/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",
1623n/a "MR",
1632n/a "MS",
1642n/a "MT",
1653n/a "MU",
1662n/a "MV",
1672n/a "MW",
1684n/a "MX",
1692n/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",
2003n/a "RO",
2014n/a "RS",
2023n/a "RW",
2033n/a "SA",
2043n/a "SB",
2053n/a "SC",
2063n/a "SD",
2073n/a "SE",
2083n/a "SG",
2093n/a "SH",
2103n/a "SI",
2113n/a "SJ",
2123n/a "SK",
2133n/a "SL",
2143n/a "SM",
2154n/a "SN",
2163n/a "SO",
2173n/a "SR",
2183n/a "SS",
2193n/a "ST",
2203n/a "SV",
2213n/a "SX",
2225n/a "SZ",
2233n/a "TC",
2243n/a "TD",
2253n/a "TF",
2263n/a "TG",
2273n/a "TH",
2283n/a "TJ",
2293n/a "TK",
2303n/a "TL",
2313n/a "TM",
2326n/a "TN",
2333n/a "TO",
2343n/a "TR",
2353n/a "TT",
2364n/a "TV",
2373n/a "TW",
2383n/a "TZ",
2393n/a "UA",
2403n/a "UG",
2414n/a "UM",
24290n/a "US",
2439n/a "UY",
2443n/a "UZ",
2453n/a "VA",
2463n/a "VC",
2473n/a "VE",
2483n/a "VG",
2493n/a "VI",
2503n/a "VN",
2513n/a "VU",
2523n/a "WF",
2533n/a "WS",
2543n/a "YE",
2553n/a "YT",
2563n/a "ZA",
2573n/a "ZM",
2586n/a "ZW"
25966818 ],
26067115 "type": "string",
26166818 },
26265512 "line1": {
26365512 "anyOf": [
26413654 {
26513654 "type": "string"
26613654 },
26764225 {
26864225 "type": "null"
26964225 }
27065512 ],
27165512 },
27264912 "line2": {
27364912 "anyOf": [
27411650 {
27511650 "type": "string"
27611650 },
27763823 {
27863823 "type": "null"
27963823 }
28064912 ],
28164912 },
28264512 "postal_code": {
28364512 "anyOf": [
28414643 {
28514643 "type": "string"
28614643 },
28763126 {
28863126 "type": "null"
28963126 }
29064512 ],
29164512 },
29264812 "state": {
29364812 "anyOf": [
29415645 {
29515645 "type": "string"
29615645 },
29763327 {
29863327 "type": "null"
29963327 }
30064812 ],
30164812 }
30261178 },
3036866 "required": [
3046866 "country"
3056866 ],
306692615 "type": "object"
307608699}
CheckoutProductsCreate135 of 146 keywords
11093573{
21120527 "properties": {
3131615 "allow_discount_codes": {
4131615 "type": "boolean"
5131615 },
6131015 "allow_trial": {
7131015 "type": "boolean"
8131015 },
9127824 "amount": {
10127824 "anyOf": [
11126735 {
1212763 "maximum": 99999999.0,
1312709 "minimum": 50.0,
14127626 "type": "integer"
15126735 },
16111291 {
17111291 "type": "null"
18111291 }
19127824 ],
20127824 },
21127625 "custom_field_data": {
225110 "additionalProperties": {
2314010 "anyOf": [
2423127 {
2523127 "type": "string"
2623127 },
2736114 {
2836114 "type": "integer"
2936114 },
3046104 {
3146104 "type": "boolean"
3246104 },
332148 {
34221 "format": "date-time",
3523127 "type": "string"
362148 },
3735115 {
3835115 "type": "null"
3935115 }
4014010 ]
415110 },
42128615 "type": "object"
43127625 },
44121196 "customer_billing_address": {
45121196 "anyOf": [
46608699 {
47608699 "$ref": "#/components/schemas/AddressInput",
48608699 },
49603704 {
50603704 "type": "null"
51603704 }
52121196 ]
53121196 },
54129712 "customer_billing_name": {
55129712 "anyOf": [
56201289 {
57201289 "type": "string"
58201289 },
59127732 {
60127732 "type": "null"
61127732 }
62129712 ],
63129712 },
64127518 "customer_email": {
65127518 "anyOf": [
66124845 {
6712876 "format": "email",
68125439 "type": "string"
69124845 },
70271266 {
71271266 "type": "null"
72271266 }
73127518 ],
74127518 },
75127612 "customer_id": {
76127612 "anyOf": [
77125830 {
7812580 "format": "uuid4",
79125830 "type": "string"
80125830 },
81181270 {
82181270 "type": "null"
83181270 }
84127612 ],
85127612 },
86128712 "customer_ip_address": {
87128712 "anyOf": [
88126831 {
8900 "format": "ipvanyaddress",
90126831 "type": "string"
91126831 },
92191280 {
93191280 "type": "null"
94191280 }
95128712 ],
96128712 },
97127521 "customer_metadata": {
98366 "additionalProperties": {
99976 "anyOf": [
1002677 {
101320 "maxLength": 500,
102266 "minLength": 1,
1033271 "type": "string"
1042677 },
1052974 {
1062974 "type": "integer"
1072974 },
1084162 {
1094162 "type": "number"
1104162 },
1113073 {
1123073 "type": "boolean"
1133073 }
114976 ]
115366 },
11612810 "maxProperties": 50,
117366 "propertyNames": {
1181003 "maxLength": 40,
1191003 "minLength": 1
120366 },
121128115 "type": "object"
122127521 },
123127916 "customer_name": {
124127916 "anyOf": [
125125441 {
12612543 "maxLength": 256,
127125738 "type": "string"
128125441 },
129251270 {
130251270 "type": "null"
131251270 }
132127916 ],
133127916 },
134127012 "customer_tax_id": {
135127012 "anyOf": [
136261256 {
137261256 "type": "string"
138261256 },
139124438 {
140124438 "type": "null"
141124438 }
142127012 ],
143127012 },
144126712 "discount_id": {
145126712 "anyOf": [
146124138 {
14712410 "format": "uuid4",
148124138 "type": "string"
149124138 },
150261253 {
151261253 "type": "null"
152261253 }
153126712 ],
154126712 },
155125212 "embed_origin": {
156125212 "anyOf": [
157221242 {
158221242 "type": "string"
159221242 },
160123034 {
161123034 "type": "null"
162123034 }
163125212 ],
164125212 },
165125612 "external_customer_id": {
166125612 "anyOf": [
167141254 {
168141254 "type": "string"
169141254 },
170124226 {
171124226 "type": "null"
172124226 }
173125612 ],
174125612 },
175126215 "is_business_customer": {
176126215 "type": "boolean"
177126215 },
178126021 "metadata": {
179466 "additionalProperties": {
1801456 "anyOf": [
18151100 {
182570 "maxLength": 500,
183516 "minLength": 1,
1845794 "type": "string"
18551100 },
18636115 {
18736115 "type": "integer"
18836115 },
1895497 {
1905497 "type": "number"
1915497 },
19240111 {
19340111 "type": "boolean"
19440111 }
1951456 ]
196466 },
19712660 "maxProperties": 50,
198466 "propertyNames": {
1991483 "maxLength": 40,
2001483 "minLength": 1
201466 },
202126615 "type": "object"
203126021 },
204125414 "prices": {
205125414 "anyOf": [
206122543 {
20782 "additionalProperties": {
208123 "items": {
2093921 "oneOf": [
210753 {
211753 "$ref": "#/components/schemas/ProductPriceFixedCreate"
212753 },
213951 {
214951 "$ref": "#/components/schemas/ProductPriceCustomCreate"
215951 },
216852 {
217852 "$ref": "#/components/schemas/ProductPriceFreeCreate"
218852 },
219456 {
220456 "$ref": "#/components/schemas/ProductPriceSeatBasedCreate"
221456 },
2221149 {
2231149 "$ref": "#/components/schemas/ProductPriceMeteredUnitCreate"
2241149 }
2253921 ]
226123 },
227150 "minItems": 1,
228150 "type": "array"
22982 },
23082 "propertyNames": {
231132 "format": "uuid4"
23282 },
233122741 "type": "object"
234122543 },
235291239 {
236291239 "type": "null"
237291239 }
238125414 ],
239125414 },
240158733 "products": {
241159015 "items": {
24228850 "format": "uuid4",
243288515 "type": "string"
244159015 },
24516023 "minItems": 1,
246160515 "type": "array"
247158733 },
248126215 "require_billing_address": {
249126215 "type": "boolean"
250126215 },
251126324 "return_url": {
252126324 "anyOf": [
253123948 {
25412429 "format": "uri",
25512483 "maxLength": 2083,
25612483 "minLength": 1,
257125136 "type": "string"
258123948 },
259241263 {
260241263 "type": "null"
261241263 }
262126324 ],
263126324 },
264123221 "seats": {
265123221 "anyOf": [
266122231 {
26712283 "maximum": 1000.0,
26812256 "minimum": 1.0,
269122825 "type": "integer"
270122231 },
271101243 {
272101243 "type": "null"
273101243 }
274123221 ],
275123221 },
276124512 "subscription_id": {
277124512 "anyOf": [
278121740 {
27912170 "format": "uuid4",
280121740 "type": "string"
281121740 },
282281229 {
283281229 "type": "null"
284281229 }
285124512 ],
286124512 },
287124624 "success_url": {
288124624 "anyOf": [
289120961 {
29012129 "format": "uri",
29112183 "maxLength": 2083,
29212183 "minLength": 1,
293122149 "type": "string"
294120961 },
295371233 {
296371233 "type": "null"
297371233 }
298124624 ],
299124624 },
300123915 "trial_interval": {
301123915 "anyOf": [
302221232 {
303221232 "$ref": "#/components/schemas/TrialInterval"
304221232 },
305121737 {
306121737 "type": "null"
307121737 }
308123915 ],
309123915 },
310123521 "trial_interval_count": {
311123521 "anyOf": [
312122333 {
31312293 "maximum": 1000.0,
31412266 "minimum": 1.0,
315122927 "type": "integer"
316122333 },
317121244 {
318121244 "type": "null"
319121244 }
320123521 ],
321123521 }
3221120527 },
323162031 "required": [
324162031 "products"
325162031 ],
326165115 "type": "object"
3271093573}
ProductPriceCustomCreate20 of 27 keywords
1951{
2944 "properties": {
3939 "amount_type": {
4939 "const": "custom",
5480 "type": "string"
6939 },
763 "maximum_amount": {
863 "anyOf": [
936 {
1040 "maximum": 1000000.0,
1131 "minimum": 50.0,
1245 "type": "integer"
1336 },
1436 {
1536 "type": "null"
1636 }
1763 ],
1863 },
1961 "minimum_amount": {
2061 "anyOf": [
2143 {
2240 "maximum": 99999999.0,
2340 "minimum": 50.0,
2443 "type": "integer"
2543 },
2625 {
2725 "type": "null"
2825 }
2961 ],
3061 },
3141 "preset_amount": {
3241 "anyOf": [
3314 {
3420 "maximum": 1000000.0,
3511 "minimum": 50.0,
3623 "type": "integer"
3714 },
3832 {
3932 "type": "null"
4032 }
4141 ],
4241 },
43200 "price_currency": {
44200 "pattern": "usd",
45200 "type": "string"
46200 }
47944 },
48485 "required": [
49485 "amount_type"
50485 ],
51537 "type": "object"
52951}
ProductPriceFixedCreate6 of 12 keywords
1753{
2741 "properties": {
3741 "amount_type": {
4741 "const": "fixed",
5480 "type": "string"
6741 },
770 "price_amount": {
870 "maximum": 99999999.0,
970 "minimum": 50.0,
1070 "type": "integer"
1170 },
12200 "price_currency": {
13200 "pattern": "usd",
14200 "type": "string"
15200 }
16741 },
17746 "required": [
18485 "amount_type",
19746 "price_amount"
20746 ],
21537 "type": "object"
22753}
ProductPriceFreeCreate6 of 7 keywords
1852{
2840 "properties": {
3840 "amount_type": {
4840 "const": "free",
5480 "type": "string"
6840 }
7840 },
8485 "required": [
9485 "amount_type"
10485 ],
11537 "type": "object"
12852}
ProductPriceMeteredUnitCreate10 of 23 keywords
11149{
22028 "properties": {
32028 "amount_type": {
42028 "const": "metered_unit",
5480 "type": "string"
62028 },
7120 "cap_amount": {
8120 "anyOf": [
993 {
1090 "maximum": 2147483647.0,
1190 "minimum": 0.0,
1293 "type": "integer"
1393 },
1439 {
1539 "type": "null"
1639 }
17120 ],
18120 },
19110 "meter_id": {
20110 "format": "uuid4",
21110 "type": "string"
22110 },
23200 "price_currency": {
24200 "pattern": "usd",
25200 "type": "string"
26200 },
27200 "unit_amount": {
28200 "anyOf": [
29128 {
30120 "exclusiveMinimum": 0.0,
31128 "type": "number"
32128 },
33812 {
3480 "pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,5}|(?=[\\d.]{1,18}0*$)\\d{0,5}\\.\\d{0,12}0*$)",
35812 "type": "string"
36812 }
37200 ],
38200 }
392028 },
401142 "required": [
41485 "amount_type",
421142 "meter_id",
432033 "unit_amount"
441142 ],
45537 "type": "object"
461149}
ProductPriceSeatBasedCreate6 of 10 keywords
1456{
2444 "properties": {
3444 "amount_type": {
4444 "const": "seat_based",
5480 "type": "string"
6444 },
7200 "price_currency": {
8200 "pattern": "usd",
9200 "type": "string"
10200 },
1140 "seat_tiers": {
1240 "$ref": "#/components/schemas/ProductPriceSeatTiers",
1340 }
14444 },
15449 "required": [
16485 "amount_type",
17449 "seat_tiers"
18449 ],
19537 "type": "object"
20456}
ProductPriceSeatTier2 of 15 keywords
1140{
2140 "properties": {
370 "max_seats": {
470 "anyOf": [
543 {
640 "minimum": 1.0,
743 "type": "integer"
843 },
934 {
1034 "type": "null"
1134 }
1270 ],
1370 },
14140 "min_seats": {
15140 "minimum": 1.0,
16140 "type": "integer"
17140 },
18140 "price_per_seat": {
19140 "maximum": 99999999.0,
20140 "minimum": 0.0,
21140 "type": "integer"
22140 }
23140 },
24140 "required": [
25140 "min_seats",
26140 "price_per_seat"
27140 ],
28140 "type": "object"
29140}
ProductPriceSeatTiers0 of 8 keywords
140{
240 "properties": {
340 "tiers": {
440 "items": {
5140 "$ref": "#/components/schemas/ProductPriceSeatTier"
640 },
740 "minItems": 1,
840 "type": "array"
940 }
1040 },
1140 "required": [
1240 "tiers"
1340 ],
1440 "type": "object"
1540}
TrialInterval3 of 3 keywords
1221232{
2221232 "enum": [
34n/a "day",
43n/a "week",
56n/a "month",
69n/a "year"
7221232 ],
8251229 "type": "string"
9221232}
Responses1 of 2 documented received
codedescriptionhitsavg
201Checkout session created.0never seen
422Validation Error16986ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error15845ms
400Bad Request974ms
401Unauthorized332ms
Examples12 / 12 used
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
Body16 of 18 keywords covered
application/json16 / 18
CheckoutCreatePublic
#validinvalidschema
152931{
253024 "properties": {
31666 "customer_email": {
41666 "anyOf": [
511953 {
61702 "format": "email",
712151 "type": "string"
811953 },
947125 {
1047125 "type": "null"
1147125 }
121666 ],
131666 },
145476 "product_id": {
155470 "format": "uuid4",
165476 "type": "string"
175476 },
181678 "seats": {
191678 "anyOf": [
2011659 {
211181 "maximum": 1000.0,
221172 "minimum": 1.0,
2311857 "type": "integer"
2411659 },
2551124 {
2651124 "type": "null"
2751124 }
281678 ],
291678 },
302355 "subscription_id": {
312355 "anyOf": [
3218555 {
331850 "format": "uuid4",
3418555 "type": "string"
3518555 },
3650190 {
3750190 "type": "null"
3850190 }
392355 ],
402355 }
4153024 },
425532 "required": [
435532 "product_id"
445532 ],
455555 "type": "object"
4652931}
Responses2 of 2 documented received
codedescriptionhitsavg
201Successful Response35920ms
422Validation Error21121ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request15ms
Path Parameters1 of 1 keywords covered
client_secret1 / 1
#validinvalidschema
1302n/a{
2302n/a "type": "string"
3302n/a}
Responses2 of 4 documented received
codedescriptionhitsavg
200Successful Response10010ms
404Checkout session not found.2024ms
410The checkout session is expired.0never seen
422Validation Error0never seen
Path Parameters1 of 1 keywords covered
client_secret1 / 1
#validinvalidschema
1664n/a{
2664n/a "type": "string"
3664n/a}
Body73 of 75 keywords covered
application/json73 / 75
CheckoutUpdatePublic
1484118{
2408113 "properties": {
34515 "allow_trial": {
44515 "anyOf": [
526430 {
626430 "const": false,
726430 "type": "boolean"
826430 },
942531 {
1042531 "type": "null"
1142531 }
124515 ],
134515 },
144228 "amount": {
154228 "anyOf": [
1640525 {
174081 "maximum": 99999999.0,
184063 "minimum": 50.0,
1940822 "type": "integer"
2040525 },
2117413 {
2217413 "type": "null"
2317413 }
244228 ],
254228 },
2642317 "custom_field_data": {
274212 "additionalProperties": {
289033 "anyOf": [
2916107 {
3016107 "type": "string"
3116107 },
3221102 {
3321102 "type": "integer"
3421102 },
3523100 {
3623100 "type": "boolean"
3723100 },
381122 {
39115 "format": "date-time",
4016107 "type": "string"
411122 },
423093 {
433093 "type": "null"
443093 }
459033 ]
464212 },
474355 "type": "object"
4842317 },
4939446 "customer_billing_address": {
5039446 "anyOf": [
51273167 {
52273167 "$ref": "#/components/schemas/AddressInput",
53273167 },
54121319 {
55121319 "type": "null"
56121319 }
5739446 ]
5839446 },
5943711 "customer_billing_name": {
6043711 "anyOf": [
6128420 {
6228420 "type": "string"
6328420 },
6440939 {
6540939 "type": "null"
6640939 }
6743711 ],
6843711 },
6942413 "customer_email": {
7042413 "anyOf": [
7141126 {
724289 "format": "email",
7342017 "type": "string"
7441126 },
7513424 {
7613424 "type": "null"
7713424 }
7842413 ],
7942413 },
804295 "customer_name": {
814295 "anyOf": [
8241915 {
834191 "maxLength": 256,
8442014 "type": "string"
8541915 },
8610424 {
8710424 "type": "null"
8810424 }
894295 ],
904295 },
914344 "customer_tax_id": {
924344 "anyOf": [
9318420 {
9418420 "type": "string"
9518420 },
9641622 {
9741622 "type": "null"
9841622 }
994344 ],
1004344 },
1014384 "discount_code": {
1024384 "anyOf": [
10316426 {
10416426 "type": "string"
10516426 },
10642220 {
10742220 "type": "null"
10842220 }
1094384 ],
1104384 },
1114224 "is_business_customer": {
1124224 "anyOf": [
11315411 {
11415411 "type": "boolean"
11515411 },
11640719 {
11740719 "type": "null"
11840719 }
1194224 ],
1204224 },
1214274 "product_id": {
1224274 "anyOf": [
12340427 {
1244040 "format": "uuid4",
12540427 "type": "string"
12640427 },
12723408 {
12823408 "type": "null"
12923408 }
1304274 ],
1314274 },
1324154 "product_price_id": {
1334154 "anyOf": [
13439920 {
1353990 "format": "uuid4",
13639920 "type": "string"
13739920 },
13816403 {
13916403 "type": "null"
14016403 }
1414154 ],
1424154 },
1434147 "seats": {
1444147 "anyOf": [
14540615 {
1464081 "maximum": 1000.0,
1474072 "minimum": 1.0,
14840813 "type": "integer"
14940615 },
1508413 {
1518413 "type": "null"
1528413 }
1534147 ],
1544147 }
155408113 },
1565975 "type": "object"
157484118}
Referenced Components (1)28 of 28 keywords
AddressInput28 of 28 keywords
1273167{
227440 "properties": {
32839 "city": {
42839 "anyOf": [
53289 {
63289 "type": "string"
73289 },
828012 {
928012 "type": "null"
1028012 }
112839 ],
122839 },
133076 "country": {
143076 "enum": [
159n/a "AD",
167n/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",
651n/a "CV",
661n/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",
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",
1232n/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",
1384n/a "LB",
1391n/a "LC",
1401n/a "LI",
1411n/a "LK",
1422n/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",
1553n/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",
1842n/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",
2212n/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",
2441n/a "UZ",
2451n/a "VA",
2461n/a "VC",
2471n/a "VE",
2481n/a "VG",
2491n/a "VI",
2501n/a "VN",
2513n/a "VU",
2521n/a "WF",
2531n/a "WS",
2541n/a "YE",
2551n/a "YT",
2561n/a "ZA",
2571n/a "ZM",
2581n/a "ZW"
2593076 ],
2603085 "type": "string",
2613076 },
2622844 "line1": {
2632844 "anyOf": [
2642286 {
2652286 "type": "string"
2662286 },
2672826 {
2682826 "type": "null"
2692826 }
2702844 ],
2712844 },
2722806 "line2": {
2732806 "anyOf": [
2742284 {
2752284 "type": "string"
2762284 },
2772788 {
2782788 "type": "null"
2792788 }
2802806 ],
2812806 },
2822874 "postal_code": {
2832874 "anyOf": [
2842289 {
2852289 "type": "string"
2862289 },
2872856 {
2882856 "type": "null"
2892856 }
2902874 ],
2912874 },
29228011 "state": {
29328011 "anyOf": [
2942289 {
2952289 "type": "string"
2962289 },
29727813 {
29827813 "type": "null"
29927813 }
30028011 ],
30128011 }
30227440 },
3033132 "required": [
3043132 "country"
3053132 ],
306315125 "type": "object"
307273167}
Responses3 of 5 documented received
codedescriptionhitsavg
200Checkout session updated.8730ms
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.7511ms
410The checkout session is expired.0never seen
422Validation Error4512ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error7897ms
400Bad Request442ms
Examples4 / 4 used
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 Parameters1 of 1 keywords covered
client_secret1 / 1
#validinvalidschema
1676n/a{
2676n/a "type": "string"
3676n/a}
Body76 of 78 keywords covered
application/json76 / 78
CheckoutConfirmStripe
1453116{
2401111 "properties": {
34555 "allow_trial": {
44555 "anyOf": [
538422 {
638422 "const": false,
738422 "type": "boolean"
838422 },
941743 {
1041743 "type": "null"
1141743 }
124555 ],
134555 },
144388 "amount": {
154388 "anyOf": [
1641630 {
174191 "maximum": 99999999.0,
184173 "minimum": 50.0,
1941927 "type": "integer"
2041630 },
2122424 {
2222424 "type": "null"
2322424 }
244388 ],
254388 },
264369 "confirmation_token_id": {
274369 "anyOf": [
2815430 {
2915430 "type": "string"
3015430 },
3142124 {
3242124 "type": "null"
3342124 }
344369 ],
354369 },
364358 "custom_field_data": {
37343 "additionalProperties": {
38933 "anyOf": [
392571 {
402571 "type": "string"
412571 },
42888 {
43888 "type": "integer"
44888 },
454452 {
464452 "type": "boolean"
474452 },
48195 {
49124 "format": "date-time",
502571 "type": "string"
51195 },
521680 {
531680 "type": "null"
541680 }
55933 ]
56343 },
574385 "type": "object"
584358 },
5942139 "customer_billing_address": {
6042139 "anyOf": [
61284176 {
62284176 "$ref": "#/components/schemas/AddressInput",
63284176 },
64137323 {
65137323 "type": "null"
66137323 }
6742139 ]
6842139 },
694374 "customer_billing_name": {
704374 "anyOf": [
7122419 {
7222419 "type": "string"
7322419 },
7441526 {
7541526 "type": "null"
7641526 }
774374 ],
784374 },
794586 "customer_email": {
804586 "anyOf": [
8144321 {
824622 "format": "email",
8344519 "type": "string"
8444321 },
8515449 {
8615449 "type": "null"
8715449 }
884586 ],
894586 },
904405 "customer_name": {
914405 "anyOf": [
9242520 {
934251 "maxLength": 256,
9442619 "type": "string"
9542520 },
9615430 {
9715430 "type": "null"
9815430 }
994405 ],
1004405 },
1014404 "customer_tax_id": {
1024404 "anyOf": [
10319425 {
10419425 "type": "string"
10519425 },
10642123 {
10742123 "type": "null"
10842123 }
1094404 ],
1104404 },
1114339 "discount_code": {
1124339 "anyOf": [
11325417 {
11425417 "type": "string"
11525417 },
11640834 {
11740834 "type": "null"
11840834 }
1194339 ],
1204339 },
1214284 "is_business_customer": {
1224284 "anyOf": [
12314418 {
12414418 "type": "boolean"
12514418 },
12641418 {
12741418 "type": "null"
12841418 }
1294284 ],
1304284 },
1314374 "product_id": {
1324374 "anyOf": [
13341031 {
1344100 "format": "uuid4",
13541031 "type": "string"
13641031 },
13727414 {
13827414 "type": "null"
13927414 }
1404374 ],
1414374 },
1424264 "product_price_id": {
1434264 "anyOf": [
14440624 {
1454060 "format": "uuid4",
14640624 "type": "string"
14740624 },
14820410 {
14920410 "type": "null"
15020410 }
1514264 ],
1524264 },
1534307 "seats": {
1544307 "anyOf": [
15541324 {
1564151 "maximum": 1000.0,
1574142 "minimum": 1.0,
15841522 "type": "integer"
15941324 },
16017420 {
16117420 "type": "null"
16217420 }
1634307 ],
1644307 }
165401111 },
1665645 "type": "object"
167453116}
Referenced Components (1)28 of 28 keywords
AddressInput28 of 28 keywords
1284176{
228533 "properties": {
33004 "city": {
43004 "anyOf": [
519285 {
619285 "type": "string"
719285 },
828123 {
928123 "type": "null"
1028123 }
113004 ],
123004 },
133116 "country": {
143116 "enum": [
157n/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",
281n/a "AW",
291n/a "AX",
301n/a "AZ",
311n/a "BA",
326n/a "BB",
331n/a "BD",
341n/a "BE",
355n/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",
552n/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",
878n/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",
1012n/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",
1416n/a "LK",
1422n/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",
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"
2593116 ],
2603125 "type": "string",
2613116 },
2622954 "line1": {
2632954 "anyOf": [
26410289 {
26510289 "type": "string"
26610289 },
26728514 {
26828514 "type": "null"
26928514 }
2702954 ],
2712954 },
2722944 "line2": {
2732944 "anyOf": [
27410288 {
27510288 "type": "string"
27610288 },
27728414 {
27828414 "type": "null"
27928414 }
2802944 ],
2812944 },
2822934 "postal_code": {
2832934 "anyOf": [
28410287 {
28510287 "type": "string"
28610287 },
28728314 {
28828314 "type": "null"
28928314 }
2902934 ],
2912934 },
29228511 "state": {
29328511 "anyOf": [
29410286 {
29510286 "type": "string"
29610286 },
29727521 {
29827521 "type": "null"
29927521 }
30028511 ],
30128511 }
30228533 },
3033172 "required": [
3043172 "country"
3053172 ],
306319141 "type": "object"
307284176}
Responses4 of 6 documented received
codedescriptionhitsavg
200Checkout session confirmed.0never seen
400The payment failed.624ms
403The checkout is expired, the customer already has an active subscription, or the organization is not ready to accept payments.1862ms
404Checkout session not found.8688ms
410The checkout session is expired.0never seen
422Validation Error5026ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error81115ms
Examples4 / 4 used
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 Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
12990{
22990 "format": "uuid4",
3299n/a "type": "string"
42990}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response24513ms
404Checkout session not found.247ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized302ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
113075{
213075 "format": "uuid4",
31312n/a "type": "string"
413075}
Body126 of 134 keywords covered
application/json126 / 134
CheckoutUpdate
1964326{
2793316 "properties": {
3100810 "allow_discount_codes": {
4100810 "anyOf": [
533985 {
633985 "type": "boolean"
733985 },
897543 {
997543 "type": "null"
1097543 }
11100810 ],
12100810 },
139948 "allow_trial": {
149948 "anyOf": [
1516986 {
1616986 "type": "boolean"
1716986 },
1897824 {
1997824 "type": "null"
2097824 }
219948 ],
229948 },
2397716 "amount": {
2497716 "anyOf": [
2595835 {
269642 "maximum": 99999999.0,
279606 "minimum": 50.0,
2896429 "type": "integer"
2995835 },
3019974 {
3119974 "type": "null"
3219974 }
3397716 ],
3497716 },
3598116 "custom_field_data": {
36466 "additionalProperties": {
371206 "anyOf": [
383096 {
393096 "type": "string"
403096 },
413690 {
423690 "type": "integer"
433690 },
442799 {
452799 "type": "boolean"
462799 },
472124 {
48228 "format": "date-time",
493096 "type": "string"
502124 },
512799 {
522799 "type": "null"
532799 }
541206 ]
55466 },
5698710 "type": "object"
5798116 },
5891765 "customer_billing_address": {
5991765 "anyOf": [
60530452 {
61530452 "$ref": "#/components/schemas/AddressInput",
62530452 },
63387595 {
64387595 "type": "null"
65387595 }
6691765 ]
6791765 },
689788 "customer_billing_name": {
699788 "anyOf": [
7025961 {
7125961 "type": "string"
7225961 },
7395333 {
7495333 "type": "null"
7595333 }
769788 ],
779788 },
7896312 "customer_email": {
7996312 "anyOf": [
8095223 {
819714 "format": "email",
8295619 "type": "string"
8395223 },
8411964 {
8511964 "type": "null"
8611964 }
8796312 ],
8896312 },
899638 "customer_ip_address": {
909638 "anyOf": [
9195219 {
9200 "format": "ipvanyaddress",
9395219 "type": "string"
9495219 },
9511960 {
9611960 "type": "null"
9711960 }
989638 ],
999638 },
10096013 "customer_metadata": {
10196013 "anyOf": [
10294330 {
10375 "additionalProperties": {
104145 "anyOf": [
105217 {
10670 "maxLength": 500,
10725 "minLength": 1,
108712 "type": "string"
109217 },
110217 {
111217 "type": "integer"
112217 },
113613 {
114613 "type": "number"
115613 },
116613 {
117613 "type": "boolean"
118613 }
119145 ]
12075 },
1219480 "maxProperties": 50,
12284 "propertyNames": {
123172 "maxLength": 40,
124172 "minLength": 1
12584 },
12694825 "type": "object"
12794330 },
12817956 {
12917956 "type": "null"
13017956 }
13196013 ],
13296013 },
13397713 "customer_name": {
13497713 "anyOf": [
13595832 {
1369582 "maxLength": 256,
13796030 "type": "string"
13895832 },
13919971 {
14019971 "type": "null"
14119971 }
14297713 ],
14397713 },
1449688 "customer_tax_id": {
1459688 "anyOf": [
14619957 {
14719957 "type": "string"
14819957 },
14994927 {
15094927 "type": "null"
15194927 }
1529688 ],
1539688 },
1549558 "discount_id": {
1559558 "anyOf": [
15694419 {
1579440 "format": "uuid4",
15894419 "type": "string"
15994419 },
16011952 {
16111952 "type": "null"
16211952 }
1639558 ],
1649558 },
1659618 "embed_origin": {
1669618 "anyOf": [
1677962 {
1687962 "type": "string"
1697962 },
17095415 {
17195415 "type": "null"
17295415 }
1739618 ],
1749618 },
1759528 "is_business_customer": {
1769528 "anyOf": [
1779951 {
1789951 "type": "boolean"
1799951 },
18094317 {
18194317 "type": "null"
18294317 }
1839528 ],
1849528 },
18595014 "metadata": {
186244 "additionalProperties": {
187964 "anyOf": [
1881684 {
189200 "maxLength": 500,
190164 "minLength": 1,
1912080 "type": "string"
1921684 },
1932872 {
1942872 "type": "integer"
1952872 },
1963367 {
1973367 "type": "number"
1983367 },
1994753 {
2004753 "type": "boolean"
2014753 }
202964 ]
203244 },
2049540 "maxProperties": 50,
205244 "propertyNames": {
206982 "maxLength": 40,
207982 "minLength": 1
208244 },
20995410 "type": "object"
21095014 },
2119608 "product_id": {
2129608 "anyOf": [
21394820 {
2149480 "format": "uuid4",
21594820 "type": "string"
21694820 },
21712956 {
21812956 "type": "null"
21912956 }
2209608 ],
2219608 },
2229478 "product_price_id": {
2239478 "anyOf": [
22493322 {
2259330 "format": "uuid4",
22693322 "type": "string"
22793322 },
22814941 {
22914941 "type": "null"
23014941 }
2319478 ],
2329478 },
2339588 "require_billing_address": {
2349588 "anyOf": [
23511955 {
23611955 "type": "boolean"
23711955 },
23894719 {
23994719 "type": "null"
24094719 }
2419588 ],
2429588 },
24393421 "return_url": {
24493421 "anyOf": [
24592728 {
24692911 "format": "uri",
2479382 "maxLength": 2083,
2489382 "minLength": 1,
24994015 "type": "string"
25092728 },
2517948 {
2527948 "type": "null"
2537948 }
25493421 ],
25593421 },
25694620 "seats": {
25794620 "anyOf": [
25893630 {
2599408 "maximum": 1000.0,
2609444 "minimum": 1.0,
26194620 "type": "integer"
26293630 },
26310956 {
26410956 "type": "null"
26510956 }
26694620 ],
26794620 },
26894016 "success_url": {
26994016 "anyOf": [
27092927 {
2719316 "format": "uri",
2729352 "maxLength": 2083,
2739352 "minLength": 1,
27493719 "type": "string"
27592927 },
27611945 {
27711945 "type": "null"
27811945 }
27994016 ],
28094016 },
28194310 "trial_interval": {
28294310 "anyOf": [
28316937 {
28416937 "$ref": "#/components/schemas/TrialInterval"
28516937 },
28692726 {
28792726 "type": "null"
28892726 }
28994310 ],
29094310 },
29193114 "trial_interval_count": {
29293114 "anyOf": [
29391134 {
2949152 "maximum": 1000.0,
2959134 "minimum": 1.0,
29691530 "type": "integer"
29791134 },
29820925 {
29920925 "type": "null"
30020925 }
30193114 ],
30293114 }
303793316 },
304128010 "type": "object"
305964326}
Referenced Components (2)31 of 31 keywords
AddressInput28 of 28 keywords
1530452{
253253 "properties": {
35629 "city": {
45629 "anyOf": [
54567 {
64567 "type": "string"
74567 },
855813 {
955813 "type": "null"
1055813 }
115629 ],
125629 },
1357112 "country": {
1457112 "enum": [
154n/a "AD",
162n/a "AE",
172n/a "AF",
182n/a "AG",
193n/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",
303n/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",
592n/a "CK",
602n/a "CL",
612n/a "CM",
622n/a "CN",
633n/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",
873n/a "FO",
883n/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",
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",
1173n/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",
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",
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",
2112n/a "SJ",
2122n/a "SK",
2132n/a "SL",
2142n/a "SM",
2152n/a "SN",
2164n/a "SO",
2172n/a "SR",
2182n/a "SS",
2192n/a "ST",
2202n/a "SV",
2212n/a "SX",
2223n/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",
2333n/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",
2523n/a "WF",
2532n/a "WS",
2542n/a "YE",
2552n/a "YT",
2562n/a "ZA",
2572n/a "ZM",
2582n/a "ZW"
25957112 ],
26057310 "type": "string",
26157112 },
2625628 "line1": {
2635628 "anyOf": [
2646564 {
2656564 "type": "string"
2666564 },
26755614 {
26855614 "type": "null"
26955614 }
2705628 ],
2715628 },
2725608 "line2": {
2735608 "anyOf": [
2748560 {
2758560 "type": "string"
2768560 },
27755216 {
27855216 "type": "null"
27955216 }
2805608 ],
2815608 },
2825608 "postal_code": {
2835608 "anyOf": [
2845563 {
2855563 "type": "string"
2865563 },
28755513 {
28855513 "type": "null"
28955513 }
2905608 ],
2915608 },
2925558 "state": {
2935558 "anyOf": [
2945558 {
2955558 "type": "string"
2965558 },
29755013 {
29855013 "type": "null"
29955013 }
3005558 ],
3015558 }
30253253 },
3035834 "required": [
3045834 "country"
3055834 ],
306587395 "type": "object"
307530452}
TrialInterval3 of 3 keywords
116937{
216937 "enum": [
32n/a "day",
43n/a "week",
56n/a "month",
65n/a "year"
716937 ],
818935 "type": "string"
916937}
Responses3 of 4 documented received
codedescriptionhitsavg
200Checkout session updated.19633ms
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.3110ms
422Validation Error10316ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error40988ms
401Unauthorized103ms
400Bad Request46ms
Examples4 / 4 used
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 Parameters17 of 27 keywords covered
organization_id2 / 7
#validinvalidschema
14050{
24050 "anyOf": [
30405 {
400 "format": "uuid4",
50n/a "type": "string",
60405 },
74050 {
84050 "items": {
94050 "format": "uuid4",
10405n/a "type": "string",
114050 },
124050 "type": "array"
134050 },
140405 {
150405 "type": "null"
160405 }
174050 ],
184050}
query3 / 3
199n/a{
299n/a "anyOf": [
394n/a {
494n/a "type": "string"
594n/a },
6594 {
7594 "type": "null"
8594 }
999n/a ],
1099n/a}
type4 / 7
110319{
210319 "anyOf": [
30122 {
40122 "$ref": "#/components/schemas/CustomFieldType"
50122 },
610319 {
710319 "items": {
830130 "$ref": "#/components/schemas/CustomFieldType"
910319 },
101220 "type": "array"
1110319 },
120122 {
130122 "type": "null"
140122 }
1510319 ],
1610319}
Referenced Components (1)3 of 3 keywords
CustomFieldType3 of 3 keywords
1301152{
2301152 "enum": [
384n/a "text",
449n/a "number",
555n/a "date",
656n/a "checkbox",
757n/a "select"
8301152 ],
9313n/a "type": "string"
10301152}
page2 / 2
114319{
21433 "exclusiveMinimum": 0,
314616 "type": "integer"
414319}
limit2 / 2
118619{
21865 "exclusiveMinimum": 0,
319114 "type": "integer"
418619}
sorting4 / 6
19318{
29318 "anyOf": [
39318 {
49318 "items": {
532822 "$ref": "#/components/schemas/CustomFieldSortProperty"
69318 },
71110 "type": "array"
89318 },
90111 {
100111 "type": "null"
110111 }
129318 ],
139318}
Referenced Components (1)3 of 3 keywords
CustomFieldSortProperty3 of 3 keywords
132822{
232822 "enum": [
330n/a "created_at",
445n/a "-created_at",
571n/a "slug",
626n/a "-slug",
728n/a "name",
840n/a "-name",
945n/a "type",
1043n/a "-type"
1132822 ],
12332n/a "type": "string"
1332822}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response2647ms
422Validation Error575ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized752ms
500Internal Server Error91483ms
Examples3 / 5 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "slug" ]sorting
Body186 of 196 keywords covered
application/json186 / 196
CustomFieldCreate
#validinvalidschema
1587739{
2587739 "oneOf": [
31571169 {
41571169 "$ref": "#/components/schemas/CustomFieldCreateText"
51571169 },
6981228 {
7981228 "$ref": "#/components/schemas/CustomFieldCreateNumber"
8981228 },
91371189 {
101371189 "$ref": "#/components/schemas/CustomFieldCreateDate"
111371189 },
12971229 {
13971229 "$ref": "#/components/schemas/CustomFieldCreateCheckbox"
14971229 },
15981228 {
16981228 "$ref": "#/components/schemas/CustomFieldCreateSelect"
17981228 }
18587739 ]
19587739}
Referenced Components (11)208 of 218 keywords
CustomFieldCheckboxProperties9 of 9 keywords
11057231{
2852181 "properties": {
386060 "form_help_text": {
486010 "minLength": 1,
587050 "type": "string"
686060 },
789761 "form_label": {
889711 "minLength": 1,
990850 "type": "string"
1089761 },
1185460 "form_placeholder": {
1285410 "minLength": 1,
1386450 "type": "string"
1485460 }
15852181 },
16123850 "type": "object"
171057231}
CustomFieldCreateCheckbox28 of 30 keywords
1971229{
21171199 "properties": {
379176 "metadata": {
412020 "additionalProperties": {
542820 "anyOf": [
6178270 {
71980 "maxLength": 500,
817820 "minLength": 1,
9198250 "type": "string"
10178270 },
1186362 {
1286362 "type": "integer"
1386362 },
14134314 {
15134314 "type": "number"
16134314 },
17116332 {
18116332 "type": "boolean"
19116332 }
2042820 ]
2112020 },
228111 "maxProperties": 50,
2311921 "propertyNames": {
2443612 "maxLength": 40,
2543711 "minLength": 1
2611921 },
2781255 "type": "object"
2879176 },
29122365 "name": {
30122310 "minLength": 1,
31123355 "type": "string"
32122365 },
33110440 "organization_id": {
34110440 "anyOf": [
35109450 {
3610940 "format": "uuid4",
37109450 "type": "string",
38109450 },
39101134 {
40101134 "type": "null"
41101134 }
42110440 ],
43110440 },
441057231 "properties": {
451057231 "$ref": "#/components/schemas/CustomFieldCheckboxProperties"
461057231 },
47121870 "slug": {
48122810 "minLength": 1,
49121820 "pattern": "^[a-z0-9-_]+$",
50123850 "type": "string"
51121870 },
522011101 "type": {
532011101 "const": "checkbox",
54125250 "type": "string"
552011101 }
561171199 },
57126056 "required": [
58130214 "type",
59128828 "slug",
60128828 "name",
61128828 "properties"
62126056 ],
63131610 "type": "object"
64971229}
CustomFieldCreateDate28 of 30 keywords
11371189{
21571159 "properties": {
379176 "metadata": {
412020 "additionalProperties": {
542820 "anyOf": [
6178270 {
71980 "maxLength": 500,
817820 "minLength": 1,
9198250 "type": "string"
10178270 },
1186362 {
1286362 "type": "integer"
1386362 },
14134314 {
15134314 "type": "number"
16134314 },
17116332 {
18116332 "type": "boolean"
19116332 }
2042820 ]
2112020 },
228111 "maxProperties": 50,
2311921 "propertyNames": {
2443612 "maxLength": 40,
2543711 "minLength": 1
2611921 },
2781255 "type": "object"
2879176 },
29122365 "name": {
30122310 "minLength": 1,
31123355 "type": "string"
32122365 },
33110440 "organization_id": {
34110440 "anyOf": [
35109450 {
3610940 "format": "uuid4",
37109450 "type": "string",
38109450 },
39101134 {
40101134 "type": "null"
41101134 }
42110440 ],
43110440 },
441009279 "properties": {
451009279 "$ref": "#/components/schemas/CustomFieldDateProperties"
461009279 },
47121870 "slug": {
48122810 "minLength": 1,
49121820 "pattern": "^[a-z0-9-_]+$",
50123850 "type": "string"
51121870 },
522611041 "type": {
532611041 "const": "date",
54125250 "type": "string"
552611041 }
561571159 },
57126056 "required": [
58130214 "type",
59128828 "slug",
60128828 "name",
61128828 "properties"
62126056 ],
63131610 "type": "object"
641371189}
CustomFieldCreateNumber28 of 30 keywords
1981228{
21181198 "properties": {
379176 "metadata": {
412020 "additionalProperties": {
542820 "anyOf": [
6178270 {
71980 "maxLength": 500,
817820 "minLength": 1,
9198250 "type": "string"
10178270 },
1186362 {
1286362 "type": "integer"
1386362 },
14134314 {
15134314 "type": "number"
16134314 },
17116332 {
18116332 "type": "boolean"
19116332 }
2042820 ]
2112020 },
228111 "maxProperties": 50,
2311921 "propertyNames": {
2443612 "maxLength": 40,
2543711 "minLength": 1
2611921 },
2781255 "type": "object"
2879176 },
29122365 "name": {
30122310 "minLength": 1,
31123355 "type": "string"
32122365 },
33110440 "organization_id": {
34110440 "anyOf": [
35109450 {
3610940 "format": "uuid4",
37109450 "type": "string",
38109450 },
39101134 {
40101134 "type": "null"
41101134 }
42110440 ],
43110440 },
441009279 "properties": {
451009279 "$ref": "#/components/schemas/CustomFieldNumberProperties"
461009279 },
47121870 "slug": {
48122810 "minLength": 1,
49121820 "pattern": "^[a-z0-9-_]+$",
50123850 "type": "string"
51121870 },
522271075 "type": {
532271075 "const": "number",
54125250 "type": "string"
552271075 }
561181198 },
57126056 "required": [
58130214 "type",
59128828 "slug",
60128828 "name",
61128828 "properties"
62126056 ],
63131610 "type": "object"
64981228}
CustomFieldCreateSelect28 of 30 keywords
1981228{
21121204 "properties": {
379176 "metadata": {
412020 "additionalProperties": {
542820 "anyOf": [
6178270 {
71980 "maxLength": 500,
817820 "minLength": 1,
9198250 "type": "string"
10178270 },
1186362 {
1286362 "type": "integer"
1386362 },
14134314 {
15134314 "type": "number"
16134314 },
17116332 {
18116332 "type": "boolean"
19116332 }
2042820 ]
2112020 },
228111 "maxProperties": 50,
2311921 "propertyNames": {
2443612 "maxLength": 40,
2543711 "minLength": 1
2611921 },
2781255 "type": "object"
2879176 },
29122365 "name": {
30122310 "minLength": 1,
31123355 "type": "string"
32122365 },
33110440 "organization_id": {
34110440 "anyOf": [
35109450 {
3610940 "format": "uuid4",
37109450 "type": "string",
38109450 },
39101134 {
40101134 "type": "null"
41101134 }
42110440 ],
43110440 },
441651123 "properties": {
451651123 "$ref": "#/components/schemas/CustomFieldSelectProperties"
461651123 },
47121870 "slug": {
48122810 "minLength": 1,
49121820 "pattern": "^[a-z0-9-_]+$",
50123850 "type": "string"
51121870 },
522571045 "type": {
532571045 "const": "select",
54125250 "type": "string"
552571045 }
561121204 },
57126056 "required": [
58130214 "type",
59128828 "slug",
60128828 "name",
61128828 "properties"
62126056 ],
63131610 "type": "object"
64981228}
CustomFieldCreateText28 of 30 keywords
11571169{
21771139 "properties": {
379176 "metadata": {
412020 "additionalProperties": {
542820 "anyOf": [
6178270 {
71980 "maxLength": 500,
817820 "minLength": 1,
9198250 "type": "string"
10178270 },
1186362 {
1286362 "type": "integer"
1386362 },
14134314 {
15134314 "type": "number"
16134314 },
17116332 {
18116332 "type": "boolean"
19116332 }
2042820 ]
2112020 },
228111 "maxProperties": 50,
2311921 "propertyNames": {
2443612 "maxLength": 40,
2543711 "minLength": 1
2611921 },
2781255 "type": "object"
2879176 },
29122365 "name": {
30122310 "minLength": 1,
31123355 "type": "string"
32122365 },
33110440 "organization_id": {
34110440 "anyOf": [
35109450 {
3610940 "format": "uuid4",
37109450 "type": "string",
38109450 },
39101134 {
40101134 "type": "null"
41101134 }
42110440 ],
43110440 },
441018270 "properties": {
451018270 "$ref": "#/components/schemas/CustomFieldTextProperties"
461018270 },
47121870 "slug": {
48122810 "minLength": 1,
49121820 "pattern": "^[a-z0-9-_]+$",
50123850 "type": "string"
51121870 },
522961006 "type": {
532961006 "const": "text",
54125250 "type": "string"
552961006 }
561771139 },
57126056 "required": [
58130214 "type",
59128828 "slug",
60128828 "name",
61128828 "properties"
62126056 ],
63131610 "type": "object"
641571169}
CustomFieldDateProperties11 of 11 keywords
11009279{
2819229 "properties": {
386060 "form_help_text": {
486010 "minLength": 1,
587050 "type": "string"
686060 },
789761 "form_label": {
889711 "minLength": 1,
990850 "type": "string"
1089761 },
1185460 "form_placeholder": {
1285410 "minLength": 1,
1386450 "type": "string"
1485460 },
1531524 "ge": {
1631524 "type": "integer"
1731524 },
1830224 "le": {
1930224 "type": "integer"
2030224 }
21819229 },
22123850 "type": "object"
231009279}
CustomFieldNumberProperties11 of 11 keywords
11009279{
2819229 "properties": {
386060 "form_help_text": {
486010 "minLength": 1,
587050 "type": "string"
686060 },
789761 "form_label": {
889711 "minLength": 1,
990850 "type": "string"
1089761 },
1185460 "form_placeholder": {
1285410 "minLength": 1,
1386450 "type": "string"
1485460 },
1531524 "ge": {
1631524 "type": "integer"
1731524 },
1830224 "le": {
1930224 "type": "integer"
2030224 }
21819229 },
22123850 "type": "object"
231009279}
CustomFieldSelectOption9 of 9 keywords
146274{
246660 "properties": {
347648 "label": {
44762 "minLength": 1,
547846 "type": "string"
647648 },
751212 "value": {
85122 "minLength": 1,
951410 "type": "string"
1051212 }
1146660 },
125224 "required": [
135242 "value",
145242 "label"
155224 ],
1652610 "type": "object"
1746274}
CustomFieldSelectProperties14 of 14 keywords
11651123{
2817237 "properties": {
386060 "form_help_text": {
486010 "minLength": 1,
587050 "type": "string"
686060 },
789761 "form_label": {
889711 "minLength": 1,
990850 "type": "string"
1089761 },
1185460 "form_placeholder": {
1285410 "minLength": 1,
1386450 "type": "string"
1485460 },
1520156 "options": {
1620343 "items": {
1746274 "$ref": "#/components/schemas/CustomFieldSelectOption"
1820343 },
192442 "minItems": 1,
2024611 "type": "array"
2120156 }
22817237 },
23257981 "required": [
24257981 "options"
25257981 ],
26123850 "type": "object"
271651123}
CustomFieldTextProperties14 of 14 keywords
11018270{
2821220 "properties": {
386060 "form_help_text": {
486010 "minLength": 1,
587050 "type": "string"
686060 },
789761 "form_label": {
889711 "minLength": 1,
990850 "type": "string"
1089761 },
1185460 "form_placeholder": {
1285410 "minLength": 1,
1386450 "type": "string"
1485460 },
1517115 "max_length": {
161733 "minimum": 0.0,
1717412 "type": "integer"
1817115 },
1917114 "min_length": {
201732 "minimum": 0.0,
2117312 "type": "integer"
2217114 },
2317010 "textarea": {
2417010 "type": "boolean"
2517010 }
26821220 },
27123850 "type": "object"
281018270}
Responses2 of 2 documented received
codedescriptionhitsavg
201Custom field created.7313ms
422Validation Error12305ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized282ms
500Internal Server Error221893ms
400Bad Request95ms
Examples5 / 5 used
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 Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
1490{
2490 "format": "uuid4",
349n/a "type": "string"
4490}
Responses2 of 3 documented received
codedescriptionhitsavg
204Custom field deleted.239ms
404Custom field not found.166ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized102ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13014{
23014 "format": "uuid4",
3305n/a "type": "string"
43014}
Responses3 of 3 documented received
codedescriptionhitsavg
200Successful Response2365ms
404Custom field not found.236ms
422Validation Error45ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized422ms
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
17110{
27110 "format": "uuid4",
3711n/a "type": "string"
47110}
Body196 of 206 keywords covered
application/json196 / 206
CustomFieldUpdate
1400300{
2400300 "oneOf": [
3235465 {
4235465 "$ref": "#/components/schemas/CustomFieldUpdateText"
5235465 },
647653 {
747653 "$ref": "#/components/schemas/CustomFieldUpdateNumber"
847653 },
946654 {
1046654 "$ref": "#/components/schemas/CustomFieldUpdateDate"
1146654 },
1234666 {
1334666 "$ref": "#/components/schemas/CustomFieldUpdateCheckbox"
1434666 },
1538662 {
1638662 "$ref": "#/components/schemas/CustomFieldUpdateSelect"
1738662 }
18400300 ]
19400300}
Referenced Components (11)228 of 238 keywords
CustomFieldCheckboxProperties9 of 9 keywords
1156223{
214290 "properties": {
318530 "form_help_text": {
41855 "minLength": 1,
519025 "type": "string"
618530 },
719030 "form_label": {
81905 "minLength": 1,
919525 "type": "string"
1019030 },
1118030 "form_placeholder": {
121805 "minLength": 1,
1318525 "type": "string"
1418030 }
1514290 },
16246133 "type": "object"
17156223}
CustomFieldDateProperties11 of 11 keywords
1132247{
2122114 "properties": {
318530 "form_help_text": {
41855 "minLength": 1,
519025 "type": "string"
618530 },
719030 "form_label": {
81905 "minLength": 1,
919525 "type": "string"
1019030 },
1118030 "form_placeholder": {
121805 "minLength": 1,
1318525 "type": "string"
1418030 },
156712 "ge": {
166712 "type": "integer"
176712 },
186712 "le": {
196712 "type": "integer"
206712 }
21122114 },
22246133 "type": "object"
23132247}
CustomFieldNumberProperties11 of 11 keywords
1132247{
2122114 "properties": {
318530 "form_help_text": {
41855 "minLength": 1,
519025 "type": "string"
618530 },
719030 "form_label": {
81905 "minLength": 1,
919525 "type": "string"
1019030 },
1118030 "form_placeholder": {
121805 "minLength": 1,
1318525 "type": "string"
1418030 },
156712 "ge": {
166712 "type": "integer"
176712 },
186712 "le": {
196712 "type": "integer"
206712 }
21122114 },
22246133 "type": "object"
23132247}
CustomFieldSelectOption9 of 9 keywords
16919{
27112 "properties": {
3766 "label": {
4761 "minLength": 1,
5775 "type": "string"
6766 },
7766 "value": {
8761 "minLength": 1,
9775 "type": "string"
10766 }
117112 },
12812 "required": [
13821 "value",
14821 "label"
15812 ],
16835 "type": "object"
176919}
CustomFieldSelectProperties14 of 14 keywords
118361{
2118115 "properties": {
318530 "form_help_text": {
41855 "minLength": 1,
519025 "type": "string"
618530 },
719030 "form_label": {
81905 "minLength": 1,
919525 "type": "string"
1019030 },
1118030 "form_placeholder": {
121805 "minLength": 1,
1318525 "type": "string"
1418030 },
153625 "options": {
163719 "items": {
176919 "$ref": "#/components/schemas/CustomFieldSelectOption"
183719 },
19551 "minItems": 1,
20565 "type": "array"
213625 }
22118115 },
2361185 "required": [
2461185 "options"
2561185 ],
26246133 "type": "object"
2718361}
CustomFieldTextProperties14 of 14 keywords
1137242{
2126109 "properties": {
318530 "form_help_text": {
41855 "minLength": 1,
519025 "type": "string"
618530 },
719030 "form_label": {
81905 "minLength": 1,
919525 "type": "string"
1019030 },
1118030 "form_placeholder": {
121805 "minLength": 1,
1318525 "type": "string"
1418030 },
15407 "max_length": {
16411 "minimum": 0.0,
17416 "type": "integer"
18407 },
19397 "min_length": {
20401 "minimum": 0.0,
21406 "type": "integer"
22397 },
23405 "textarea": {
24405 "type": "boolean"
25405 }
26126109 },
27246133 "type": "object"
28137242}
CustomFieldUpdateCheckbox32 of 34 keywords
134666{
235659 "properties": {
333635 "metadata": {
46310 "additionalProperties": {
510310 "anyOf": [
61499 {
7240 "maxLength": 500,
81410 "minLength": 1,
92489 "type": "string"
101499 },
112588 {
122588 "type": "integer"
132588 },
147637 {
157637 "type": "number"
167637 },
1713100 {
1813100 "type": "boolean"
1913100 }
2010310 ]
216310 },
223460 "maxProperties": 50,
236310 "propertyNames": {
241085 "maxLength": 40,
251085 "minLength": 1
266310 },
2734625 "type": "object"
2833635 },
2929431 "name": {
3029431 "anyOf": [
3128540 {
322855 "minLength": 1,
3329035 "type": "string"
3428540 },
359316 {
369316 "type": "null"
379316 }
3829431 ],
3929431 },
40269110 "properties": {
41269110 "anyOf": [
42156223 {
43156223 "$ref": "#/components/schemas/CustomFieldCheckboxProperties"
44156223 },
45113266 {
46113266 "type": "null"
47113266 }
48269110 ]
49269110 },
5033535 "slug": {
5133535 "anyOf": [
5232743 {
533375 "minLength": 1,
5432715 "pattern": "^[a-z0-9-_]+$",
5534228 "type": "string"
5632743 },
578362 {
588362 "type": "null"
598362 }
6033535 ],
6133535 },
6275618 "type": {
6375618 "const": "checkbox",
6468310 "type": "string"
6575618 }
6635659 },
676931 "required": [
686931 "type"
696931 ],
706946 "type": "object"
7134666}
CustomFieldUpdateDate32 of 34 keywords
146654{
247647 "properties": {
333635 "metadata": {
46310 "additionalProperties": {
510310 "anyOf": [
61499 {
7240 "maxLength": 500,
81410 "minLength": 1,
92489 "type": "string"
101499 },
112588 {
122588 "type": "integer"
132588 },
147637 {
157637 "type": "number"
167637 },
1713100 {
1813100 "type": "boolean"
1913100 }
2010310 ]
216310 },
223460 "maxProperties": 50,
236310 "propertyNames": {
241085 "maxLength": 40,
251085 "minLength": 1
266310 },
2734625 "type": "object"
2833635 },
2929431 "name": {
3029431 "anyOf": [
3128540 {
322855 "minLength": 1,
3329035 "type": "string"
3428540 },
359316 {
369316 "type": "null"
379316 }
3829431 ],
3929431 },
40245134 "properties": {
41245134 "anyOf": [
42132247 {
43132247 "$ref": "#/components/schemas/CustomFieldDateProperties"
44132247 },
45113266 {
46113266 "type": "null"
47113266 }
48245134 ]
49245134 },
5033535 "slug": {
5133535 "anyOf": [
5232743 {
533375 "minLength": 1,
5432715 "pattern": "^[a-z0-9-_]+$",
5534228 "type": "string"
5632743 },
578362 {
588362 "type": "null"
598362 }
6033535 ],
6133535 },
6299594 "type": {
6399594 "const": "date",
6468310 "type": "string"
6599594 }
6647647 },
676931 "required": [
686931 "type"
696931 ],
706946 "type": "object"
7146654}
CustomFieldUpdateNumber32 of 34 keywords
147653{
248646 "properties": {
333635 "metadata": {
46310 "additionalProperties": {
510310 "anyOf": [
61499 {
7240 "maxLength": 500,
81410 "minLength": 1,
92489 "type": "string"
101499 },
112588 {
122588 "type": "integer"
132588 },
147637 {
157637 "type": "number"
167637 },
1713100 {
1813100 "type": "boolean"
1913100 }
2010310 ]
216310 },
223460 "maxProperties": 50,
236310 "propertyNames": {
241085 "maxLength": 40,
251085 "minLength": 1
266310 },
2734625 "type": "object"
2833635 },
2929431 "name": {
3029431 "anyOf": [
3128540 {
322855 "minLength": 1,
3329035 "type": "string"
3428540 },
359316 {
369316 "type": "null"
379316 }
3829431 ],
3929431 },
40245134 "properties": {
41245134 "anyOf": [
42132247 {
43132247 "$ref": "#/components/schemas/CustomFieldNumberProperties"
44132247 },
45113266 {
46113266 "type": "null"
47113266 }
48245134 ]
49245134 },
5033535 "slug": {
5133535 "anyOf": [
5232743 {
533375 "minLength": 1,
5432715 "pattern": "^[a-z0-9-_]+$",
5534228 "type": "string"
5632743 },
578362 {
588362 "type": "null"
598362 }
6033535 ],
6133535 },
62100593 "type": {
63100593 "const": "number",
6468310 "type": "string"
65100593 }
6648646 },
676931 "required": [
686931 "type"
696931 ],
706946 "type": "object"
7147653}
CustomFieldUpdateSelect32 of 34 keywords
138662{
239655 "properties": {
333635 "metadata": {
46310 "additionalProperties": {
510310 "anyOf": [
61499 {
7240 "maxLength": 500,
81410 "minLength": 1,
92489 "type": "string"
101499 },
112588 {
122588 "type": "integer"
132588 },
147637 {
157637 "type": "number"
167637 },
1713100 {
1813100 "type": "boolean"
1913100 }
2010310 ]
216310 },
223460 "maxProperties": 50,
236310 "propertyNames": {
241085 "maxLength": 40,
251085 "minLength": 1
266310 },
2734625 "type": "object"
2833635 },
2929431 "name": {
3029431 "anyOf": [
3128540 {
322855 "minLength": 1,
3329035 "type": "string"
3428540 },
359316 {
369316 "type": "null"
379316 }
3829431 ],
3929431 },
40131248 "properties": {
41131248 "anyOf": [
4218361 {
4318361 "$ref": "#/components/schemas/CustomFieldSelectProperties"
4418361 },
45113266 {
46113266 "type": "null"
47113266 }
48131248 ]
49131248 },
5033535 "slug": {
5133535 "anyOf": [
5232743 {
533375 "minLength": 1,
5432715 "pattern": "^[a-z0-9-_]+$",
5534228 "type": "string"
5632743 },
578362 {
588362 "type": "null"
598362 }
6033535 ],
6133535 },
62106587 "type": {
63106587 "const": "select",
6468310 "type": "string"
65106587 }
6639655 },
676931 "required": [
686931 "type"
696931 ],
706946 "type": "object"
7138662}
CustomFieldUpdateText32 of 34 keywords
1235465{
2236458 "properties": {
333635 "metadata": {
46310 "additionalProperties": {
510310 "anyOf": [
61499 {
7240 "maxLength": 500,
81410 "minLength": 1,
92489 "type": "string"
101499 },
112588 {
122588 "type": "integer"
132588 },
147637 {
157637 "type": "number"
167637 },
1713100 {
1813100 "type": "boolean"
1913100 }
2010310 ]
216310 },
223460 "maxProperties": 50,
236310 "propertyNames": {
241085 "maxLength": 40,
251085 "minLength": 1
266310 },
2734625 "type": "object"
2833635 },
2929431 "name": {
3029431 "anyOf": [
3128540 {
322855 "minLength": 1,
3329035 "type": "string"
3428540 },
359316 {
369316 "type": "null"
379316 }
3829431 ],
3929431 },
40250129 "properties": {
41250129 "anyOf": [
42137242 {
43137242 "$ref": "#/components/schemas/CustomFieldTextProperties"
44137242 },
45113266 {
46113266 "type": "null"
47113266 }
48250129 ]
49250129 },
5033535 "slug": {
5133535 "anyOf": [
5232743 {
533375 "minLength": 1,
5432715 "pattern": "^[a-z0-9-_]+$",
5534228 "type": "string"
5632743 },
578362 {
588362 "type": "null"
598362 }
6033535 ],
6133535 },
62301392 "type": {
63301392 "const": "text",
6468310 "type": "string"
65301392 }
66236458 },
676931 "required": [
686931 "type"
696931 ],
706946 "type": "object"
71235465}
Responses3 of 3 documented received
codedescriptionhitsavg
200Custom field updated.819ms
404Custom field not found.1506ms
422Validation Error4726ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized44ms
500Internal Server Error22165ms
400Bad Request26ms
customer_meters 2 operations 1 covered 1 partial 0 uncovered 0 not measured 47% #
Query Parameters20 of 36 keywords covered
organization_id2 / 7
#validinvalidschema
15410{
25410 "anyOf": [
30541 {
400 "format": "uuid4",
50n/a "type": "string",
60541 },
75410 {
85410 "items": {
95410 "format": "uuid4",
10541n/a "type": "string",
115410 },
125410 "type": "array"
135410 },
140541 {
150541 "type": "null"
160541 }
175410 ],
185410}
customer_id3 / 7
11785{
21785 "anyOf": [
30183 {
400 "format": "uuid4",
50n/a "type": "string"
60183 },
71785 {
81785 "items": {
93390 "format": "uuid4",
10339n/a "type": "string"
111785 },
121830 "type": "array"
131785 },
140183 {
150183 "type": "null"
160183 }
171785 ],
181785}
external_customer_id3 / 5
194n/a{
294n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
69462 {
794n/a "items": {
8519n/a "type": "string"
994n/a },
101560 "type": "array"
119462 },
120156 {
130156 "type": "null"
140156 }
1594n/a ],
1694n/a}
meter_id4 / 7
14486{
24486 "anyOf": [
30454 {
400 "format": "uuid4",
50n/a "type": "string"
60454 },
74486 {
84486 "items": {
954218 "format": "uuid4",
10560n/a "type": "string"
114486 },
124540 "type": "array"
134486 },
140454 {
150454 "type": "null"
160454 }
174486 ],
184486}
page2 / 2
120617{
22062 "exclusiveMinimum": 0,
320815 "type": "integer"
420617}
limit2 / 2
123115{
22312 "exclusiveMinimum": 0,
323313 "type": "integer"
423115}
sorting4 / 6
113113{
213113 "anyOf": [
313113 {
413113 "items": {
547415 "$ref": "#/components/schemas/CustomerMeterSortProperty"
613113 },
71440 "type": "array"
813113 },
90144 {
100144 "type": "null"
110144 }
1213113 ],
1313113}
Referenced Components (1)3 of 3 keywords
CustomerMeterSortProperty3 of 3 keywords
147415{
247415 "enum": [
317n/a "created_at",
426n/a "-created_at",
520n/a "modified_at",
660n/a "-modified_at",
732n/a "customer_id",
823n/a "-customer_id",
918n/a "customer_name",
1023n/a "-customer_name",
1127n/a "meter_id",
1232n/a "-meter_id",
1325n/a "meter_name",
1444n/a "-meter_name",
1529n/a "consumed_units",
1615n/a "-consumed_units",
1718n/a "credited_units",
1817n/a "-credited_units",
1929n/a "balance",
2019n/a "-balance"
2147415 ],
22476n/a "type": "string"
2347415}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response4127ms
422Validation Error475ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized742ms
500Internal Server Error81435ms
Examples3 / 5 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-modified_at" ]sorting
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
129013{
229013 "format": "uuid4",
3303n/a "type": "string"
429013}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Customer meter not found.2726ms
422Validation Error135ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized182ms
customer_portal 43 operations 25 covered 18 partial 0 uncovered 0 not measured 82% #
Query Parameters24 of 45 keywords covered
type4 / 7
#validinvalidschema
19812{
29812 "anyOf": [
30110 {
40110 "$ref": "#/components/schemas/BenefitType"
50110 },
69812 {
79812 "items": {
820214 "$ref": "#/components/schemas/BenefitType"
99812 },
101100 "type": "array"
119812 },
120110 {
130110 "type": "null"
140110 }
159812 ],
169812}
Referenced Components (1)3 of 3 keywords
BenefitType3 of 3 keywords
1202124{
2202124 "enum": [
375n/a "custom",
427n/a "discord",
522n/a "github_repository",
620n/a "downloadables",
723n/a "license_keys",
835n/a "meter_credit"
9202124 ],
10204n/a "type": "string"
11202124}
benefit_id3 / 7
13464{
23464 "anyOf": [
30350 {
400 "format": "uuid4",
50n/a "type": "string"
60350 },
73464 {
83464 "items": {
93460 "format": "uuid4",
10346n/a "type": "string"
113464 },
123500 "type": "array"
133464 },
140350 {
150350 "type": "null"
160350 }
173464 ],
183464}
checkout_id3 / 7
13464{
23464 "anyOf": [
30350 {
400 "format": "uuid4",
50n/a "type": "string"
60350 },
73464 {
83464 "items": {
93490 "format": "uuid4",
10349n/a "type": "string"
113464 },
123500 "type": "array"
133464 },
140350 {
150350 "type": "null"
160350 }
173464 ],
183464}
order_id3 / 7
11384{
21384 "anyOf": [
30142 {
400 "format": "uuid4",
50n/a "type": "string"
60142 },
71384 {
81384 "items": {
92440 "format": "uuid4",
10244n/a "type": "string"
111384 },
121420 "type": "array"
131384 },
140142 {
150142 "type": "null"
160142 }
171384 ],
181384}
subscription_id3 / 7
12354{
22354 "anyOf": [
30239 {
400 "format": "uuid4",
50n/a "type": "string"
60239 },
72354 {
82354 "items": {
93410 "format": "uuid4",
10341n/a "type": "string"
112354 },
122390 "type": "array"
132354 },
140239 {
150239 "type": "null"
160239 }
172354 ],
182354}
page2 / 2
115723{
21572 "exclusiveMinimum": 0,
315921 "type": "integer"
415723}
limit2 / 2
117223{
21722 "exclusiveMinimum": 0,
317421 "type": "integer"
417223}
sorting4 / 6
19512{
29512 "anyOf": [
39512 {
49512 "items": {
532414 "$ref": "#/components/schemas/CustomerBenefitGrantSortProperty"
69512 },
71070 "type": "array"
89512 },
90107 {
100107 "type": "null"
110107 }
129512 ],
139512}
Referenced Components (1)3 of 3 keywords
CustomerBenefitGrantSortProperty3 of 3 keywords
132414{
232414 "enum": [
329n/a "granted_at",
468n/a "-granted_at",
528n/a "type",
647n/a "-type",
726n/a "organization",
835n/a "-organization",
972n/a "product_benefit",
1019n/a "-product_benefit"
1132414 ],
12326n/a "type": "string"
1332414}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response1916ms
422Validation Error644ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1402ms
500Internal Server Error61417ms
Examples3 / 3 used
Query
1page
10limit
[ "product_benefit", "-granted_at" ]sorting
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13030{
23030 "format": "uuid4",
3303n/a "type": "string"
43030}
Responses1 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Benefit grant not found.2755ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized282ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13521{
23521 "format": "uuid4",
3353n/a "type": "string"
43521}
Body51 of 51 keywords covered
application/json51 / 51
CustomerBenefitGrantUpdate
127551{
227551 "oneOf": [
349277 {
449277 "$ref": "#/components/schemas/CustomerBenefitGrantDiscordUpdate"
549277 },
627299 {
727299 "$ref": "#/components/schemas/CustomerBenefitGrantGitHubRepositoryUpdate"
827299 },
9154172 {
10154172 "$ref": "#/components/schemas/CustomerBenefitGrantDownloadablesUpdate"
11154172 },
126320 {
136320 "$ref": "#/components/schemas/CustomerBenefitGrantLicenseKeysUpdate"
146320 },
1514312 {
1614312 "$ref": "#/components/schemas/CustomerBenefitGrantCustomUpdate"
1714312 },
1825301 {
1925301 "$ref": "#/components/schemas/CustomerBenefitGrantMeterCreditUpdate"
2025301 }
2127551 ]
2227551}
Referenced Components (8)62 of 62 keywords
CustomerBenefitGrantCustomUpdate7 of 7 keywords
114312{
214299 "properties": {
314299 "benefit_type": {
414299 "const": "custom",
530211 "type": "string"
614299 }
714299 },
83132 "required": [
93132 "benefit_type"
103132 ],
1131511 "type": "object"
1214312}
CustomerBenefitGrantDiscordPropertiesUpdate9 of 9 keywords
18323{
28311 "properties": {
38311 "account_id": {
48311 "anyOf": [
51579 {
61579 "type": "string"
71579 },
86826 {
96826 "type": "null"
106826 }
118311 ],
128311 }
138311 },
14942 "required": [
15942 "account_id"
16942 ],
179610 "type": "object"
188323}
CustomerBenefitGrantDiscordUpdate8 of 8 keywords
149277{
251263 "properties": {
363250 "benefit_type": {
463250 "const": "discord",
530211 "type": "string"
663250 },
78323 "properties": {
88323 "$ref": "#/components/schemas/CustomerBenefitGrantDiscordPropertiesUpdate"
98323 }
1051263 },
11105210 "required": [
123132 "benefit_type",
13106209 "properties"
14105210 ],
1531511 "type": "object"
1649277}
CustomerBenefitGrantDownloadablesUpdate7 of 7 keywords
1154172{
2154159 "properties": {
3154159 "benefit_type": {
4154159 "const": "downloadables",
530211 "type": "string"
6154159 }
7154159 },
83132 "required": [
93132 "benefit_type"
103132 ],
1131511 "type": "object"
12154172}
CustomerBenefitGrantGitHubRepositoryPropertiesUpdate9 of 9 keywords
18323{
28311 "properties": {
38311 "account_id": {
48311 "anyOf": [
51579 {
61579 "type": "string"
71579 },
86826 {
96826 "type": "null"
106826 }
118311 ],
128311 }
138311 },
14942 "required": [
15942 "account_id"
16942 ],
179610 "type": "object"
188323}
CustomerBenefitGrantGitHubRepositoryUpdate8 of 8 keywords
127299{
229285 "properties": {
338275 "benefit_type": {
438275 "const": "github_repository",
530211 "type": "string"
638275 },
78323 "properties": {
88323 "$ref": "#/components/schemas/CustomerBenefitGrantGitHubRepositoryPropertiesUpdate"
98323 }
1029285 },
11105210 "required": [
123132 "benefit_type",
13106209 "properties"
14105210 ],
1531511 "type": "object"
1627299}
CustomerBenefitGrantLicenseKeysUpdate7 of 7 keywords
16320{
26307 "properties": {
36307 "benefit_type": {
46307 "const": "license_keys",
530211 "type": "string"
66307 }
76307 },
83132 "required": [
93132 "benefit_type"
103132 ],
1131511 "type": "object"
126320}
CustomerBenefitGrantMeterCreditUpdate7 of 7 keywords
125301{
225288 "properties": {
325288 "benefit_type": {
425288 "const": "meter_credit",
530211 "type": "string"
625288 }
725288 },
83132 "required": [
93132 "benefit_type"
103132 ],
1131511 "type": "object"
1225301}
Responses2 of 4 documented received
codedescriptionhitsavg
200Benefit grant updated.0never seen
403The benefit grant is revoked and cannot be updated.0never seen
404Benefit grant not found.2635ms
422Validation Error683ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized124ms
400Bad Request104ms
Body4 of 4 keywords covered
application/json4 / 4
CustomerSessionCodeAuthenticateRequest
#validinvalidschema
110044{
210022 "properties": {
310022 "code": {
410022 "type": "string"
510022 }
610022 },
712217 "required": [
812217 "code"
912217 ],
101395 "type": "object"
1110044}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
401Invalid or expired verification code.814ms
422Validation Error552ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error19699ms
400Bad Request32ms
Responses1 of 1 documented received
codedescriptionhitsavg
200Successful Response483ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2572ms
Body6 of 7 keywords covered
application/json6 / 7
CustomerSessionCodeRequest
#validinvalidschema
120826{
221217 "properties": {
321412 "email": {
42197 "format": "email",
52215 "type": "string"
621412 },
72235 "organization_id": {
82230 "format": "uuid4",
92235 "type": "string"
102235 }
1121217 },
122254 "required": [
132263 "email",
142281 "organization_id"
152254 ],
162295 "type": "object"
1720826}
Responses2 of 2 documented received
codedescriptionhitsavg
202Successful Response10335ms
422Validation Error1486ms
Responses1 of 1 documented received
codedescriptionhitsavg
200Successful Response713ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2342ms
Body31 of 31 keywords covered
application/json31 / 31
CustomerPortalCustomerUpdate
#validinvalidschema
1416127{
2415117 "properties": {
3430101 "billing_address": {
4430101 "anyOf": [
5344187 {
6344187 "$ref": "#/components/schemas/AddressInput"
7344187 },
886445 {
986445 "type": "null"
1086445 }
11430101 ]
12430101 },
1344215 "billing_name": {
1444215 "anyOf": [
1549408 {
1649408 "type": "string"
1749408 },
1839364 {
1939364 "type": "null"
2039364 }
2144215 ],
2244215 },
2342812 "tax_id": {
2442812 "anyOf": [
2514426 {
2614426 "type": "string"
2714426 },
2841426 {
2941426 "type": "null"
3041426 }
3142812 ],
3242812 }
33415117 },
3453310 "type": "object"
35416127}
Referenced Components (1)28 of 28 keywords
AddressInput28 of 28 keywords
1344187{
234681 "properties": {
33788 "city": {
43788 "anyOf": [
513373 {
613373 "type": "string"
713373 },
836521 {
936521 "type": "null"
1036521 }
113788 ],
123788 },
1341312 "country": {
1441312 "enum": [
1519n/a "AD",
164n/a "AE",
171n/a "AF",
181n/a "AG",
195n/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",
417n/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",
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",
871n/a "FO",
8816n/a "FR",
892n/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",
1072n/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",
1382n/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",
1696n/a "MY",
1701n/a "MZ",
1711n/a "NA",
1721n/a "NC",
1731n/a "NE",
1741n/a "NF",
1751n/a "NG",
1764n/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",
1867n/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",
1967n/a "PW",
1971n/a "PY",
1981n/a "QA",
1991n/a "RE",
2001n/a "RO",
2011n/a "RS",
2021n/a "RW",
2031n/a "SA",
2043n/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",
2158n/a "SN",
2161n/a "SO",
2172n/a "SR",
2183n/a "SS",
2192n/a "ST",
2202n/a "SV",
2212n/a "SX",
2222n/a "SZ",
2233n/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",
2343n/a "TR",
2352n/a "TT",
2362n/a "TV",
2372n/a "TW",
2382n/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",
2482n/a "VG",
2492n/a "VI",
2502n/a "VN",
2512n/a "VU",
2522n/a "WF",
2532n/a "WS",
2542n/a "YE",
2554n/a "YT",
2562n/a "ZA",
2572n/a "ZM",
2582n/a "ZW"
25941312 ],
26041510 "type": "string",
26141312 },
26236822 "line1": {
26336822 "anyOf": [
26411379 {
26511379 "type": "string"
26611379 },
26735733 {
26835733 "type": "null"
26935733 }
27036822 ],
27136822 },
27236114 "line2": {
27336114 "anyOf": [
27412363 {
27512363 "type": "string"
27612363 },
27734926 {
27834926 "type": "null"
27934926 }
28036114 ],
28136114 },
28236416 "postal_code": {
28336416 "anyOf": [
28411369 {
28511369 "type": "string"
28611369 },
28735327 {
28835327 "type": "null"
28935327 }
29036416 ],
29136416 },
29236322 "state": {
29336322 "anyOf": [
2947378 {
2957378 "type": "string"
2967378 },
29735629 {
29835629 "type": "null"
29935629 }
30036322 ],
30136322 }
30234681 },
3034254 "required": [
3044254 "country"
3054254 ],
306429102 "type": "object"
307344187}
Responses1 of 2 documented received
codedescriptionhitsavg
200Customer updated.0never seen
422Validation Error5215ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error55886ms
401Unauthorized253ms
400Bad Request673ms
Examples3 / 3 used
Body: application/json
"US"AddressInput.country.examples[0]
"SE"AddressInput.country.examples[1]
"FR"AddressInput.country.examples[2]
Query Parameters4 of 4 keywords covered
page2 / 2
#validinvalidschema
18657{
28619 "exclusiveMinimum": 0,
310538 "type": "integer"
48657}
limit2 / 2
113146{
213119 "exclusiveMinimum": 0,
315027 "type": "integer"
413146}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response1354ms
422Validation Error593ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1392ms
500Internal Server Error11378ms
Examples2 / 2 used
Query
1page
10limit
Body6 of 6 keywords covered
application/json6 / 6
CustomerPaymentMethodCreate
#validinvalidschema
12524{
22915 "properties": {
3375 "confirmation_token_id": {
4375 "type": "string"
5375 },
6385 "return_url": {
7385 "type": "string"
8385 },
9385 "set_default": {
10385 "type": "boolean"
11385 }
122915 },
13404 "required": [
14422 "confirmation_token_id",
15431 "set_default",
16431 "return_url"
17404 ],
18445 "type": "object"
192524}
Responses1 of 2 documented received
codedescriptionhitsavg
201Payment method created or setup initiated.0never seen
422Validation Error313ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized82ms
500Internal Server Error18961ms
400Bad Request23ms
Body5 of 5 keywords covered
application/json5 / 5
CustomerPaymentMethodConfirm
#validinvalidschema
17230{
28214 "properties": {
3878 "set_default": {
4878 "type": "boolean"
5878 },
6789 "setup_intent_id": {
7789 "type": "string"
8789 }
98214 },
108610 "required": [
11879 "setup_intent_id",
12951 "set_default"
138610 ],
14966 "type": "object"
157230}
Responses2 of 3 documented received
codedescriptionhitsavg
201Payment method created or setup initiated.0never seen
400Customer is not ready to confirm a payment method.33ms
422Validation Error8411ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized162ms
500Internal Server Error13966ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
12967{
22967 "format": "uuid4",
3303n/a "type": "string"
42967}
Responses2 of 4 documented received
codedescriptionhitsavg
204Payment method deleted.0never seen
400Payment method is used by active subscription(s).0never seen
404Payment method not found.2644ms
422Validation Error73ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized322ms
Query Parameters8 of 11 keywords covered
benefit_id4 / 7
#validinvalidschema
159010{
259010 "anyOf": [
30600 {
400 "format": "uuid4",
50n/a "type": "string",
60600 },
759010 {
859010 "items": {
962114 "format": "uuid4",
10635n/a "type": "string",
1159010 },
126000 "type": "array"
1359010 },
140600 {
150600 "type": "null"
160600 }
1759010 ],
1859010}
page2 / 2
129721{
22972 "exclusiveMinimum": 0,
329919 "type": "integer"
429721}
limit2 / 2
134120{
23412 "exclusiveMinimum": 0,
334318 "type": "integer"
434120}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response4945ms
422Validation Error363ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1505ms
500Internal Server Error21674ms
Examples2 / 2 used
Query
1page
10limit
Path Parameters1 of 1 keywords covered
token1 / 1
#validinvalidschema
1202n/a{
2202n/a "type": "string"
3202n/a}
Responses1 of 6 documented received
codedescriptionhitsavg
200Successful Response0never seen
302Redirected to download0never seen
400Invalid signature0never seen
404Downloadable not found2024ms
410Expired signature0never seen
422Validation Error0never seen
Query Parameters8 of 8 keywords covered
benefit_id4 / 4
#validinvalidschema
139113{
239113 "anyOf": [
338915 {
438913 "format": "uuid4",
5402n/a "type": "string",
638915 },
72402 {
82402 "type": "null"
92402 }
1039113 ],
1139113}
page2 / 2
120923{
22092 "exclusiveMinimum": 0,
321121 "type": "integer"
420923}
limit2 / 2
115527{
21552 "exclusiveMinimum": 0,
315725 "type": "integer"
415527}
Responses3 of 4 documented received
codedescriptionhitsavg
200Successful Response4225ms
401Not authorized to manage license key.532ms
404License key not found.0never seen
422Validation Error373ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error91394ms
Examples2 / 2 used
Query
1page
10limit
Body25 of 29 keywords covered
application/json25 / 29
LicenseKeyActivate
#validinvalidschema
140186{
241661 "properties": {
323417 "conditions": {
41187 "additionalProperties": {
539512 "anyOf": [
6129278 {
71336 "maxLength": 500,
81354 "minLength": 1,
9139268 "type": "string"
10129278 },
11115292 {
12115292 "type": "integer"
13115292 },
14142265 {
15142265 "type": "number"
16142265 },
17124283 {
18124283 "type": "boolean"
19124283 }
2039512 ]
211187 },
222410 "maxProperties": 50,
231214 "propertyNames": {
244052 "maxLength": 40,
254052 "minLength": 1
261214 },
2724110 "type": "object"
2823417 },
2945610 "key": {
3045610 "type": "string"
3145610 },
3246410 "label": {
3346410 "type": "string"
3446410 },
3522216 "meta": {
361145 "additionalProperties": {
373095 "anyOf": [
38104210 {
391090 "maxLength": 500,
401045 "minLength": 1,
41109205 "type": "string"
42104210 },
4368246 {
4468246 "type": "integer"
4568246 },
4698216 {
4798216 "type": "number"
4898216 },
49107207 {
50107207 "type": "boolean"
51107207 }
523095 ]
531145 },
542280 "maxProperties": 50,
551145 "propertyNames": {
563122 "maxLength": 40,
573113 "minLength": 1
581145 },
5922810 "type": "object"
6022216 },
6146510 "organization_id": {
624650 "format": "uuid4",
6346510 "type": "string"
6446510 }
6541661 },
6646215 "required": [
6746611 "key",
684752 "organization_id",
694743 "label"
7046215 ],
7147710 "type": "object"
7240186}
Responses2 of 4 documented received
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.3995ms
422Validation Error1633ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request873ms
500Internal Server Error21242ms
Body6 of 8 keywords covered
application/json6 / 8
LicenseKeyDeactivate
#validinvalidschema
111046{
211630 "properties": {
313410 "activation_id": {
41340 "format": "uuid4",
513410 "type": "string"
613410 },
713410 "key": {
813410 "type": "string"
913410 },
1013410 "organization_id": {
111340 "format": "uuid4",
1213410 "type": "string"
1313410 }
1411630 },
151406 "required": [
161442 "key",
171442 "organization_id",
181442 "activation_id"
191406 ],
2014610 "type": "object"
2111046}
Responses2 of 3 documented received
codedescriptionhitsavg
204License key activation deactivated.0never seen
404License key not found.1094ms
422Validation Error1002ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request593ms
500Internal Server Error11373ms
Body27 of 32 keywords covered
application/json27 / 32
LicenseKeyValidate
#validinvalidschema
1168113{
218586 "properties": {
31498 "activation_id": {
41498 "anyOf": [
512532 {
61250 "format": "uuid4",
712532 "type": "string"
812532 },
924133 {
1024133 "type": "null"
1124133 }
121498 ],
131498 },
142278 "benefit_id": {
152278 "anyOf": [
1621817 {
172180 "format": "uuid4",
1821817 "type": "string",
1921817 },
209226 {
219226 "type": "null"
229226 }
232278 ],
242278 },
2514625 "conditions": {
265615 "additionalProperties": {
2717830 "anyOf": [
2867141 {
29722 "maxLength": 500,
30695 "minLength": 1,
3174134 "type": "string"
3267141 },
3350158 {
3450158 "type": "integer"
3550158 },
3674134 {
3774134 "type": "number"
3874134 },
3937171 {
4037171 "type": "boolean"
4137171 }
4217830 ]
435615 },
441610 "maxProperties": 50,
45674 "propertyNames": {
462062 "maxLength": 40,
472062 "minLength": 1
48674 },
4916110 "type": "object"
5014625 },
5114315 "customer_id": {
5214315 "anyOf": [
5311048 {
541100 "format": "uuid4",
5511048 "type": "string"
5611048 },
5733125 {
5833125 "type": "null"
5933125 }
6014315 ],
6114315 },
6214217 "increment_usage": {
6314217 "anyOf": [
6445114 {
6545114 "type": "integer"
6645114 },
679762 {
689762 "type": "null"
699762 }
7014217 ],
7114217 },
7224610 "key": {
7324610 "type": "string"
7424610 },
7525510 "organization_id": {
762550 "format": "uuid4",
7725510 "type": "string"
7825510 }
7918586 },
8025417 "required": [
8125615 "key",
822656 "organization_id"
8325417 ],
8427110 "type": "object"
85168113}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404License key not found.1704ms
422Validation Error1863ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request873ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13025{
23025 "format": "uuid4",
3307n/a "type": "string"
43025}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404License key not found.2564ms
422Validation Error53ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized462ms
Query Parameters15 of 20 keywords covered
meter_id4 / 7
#validinvalidschema
110025{
210025 "anyOf": [
30125 {
400 "format": "uuid4",
50n/a "type": "string"
60125 },
710025 {
810025 "items": {
922547 "format": "uuid4",
10272n/a "type": "string"
1110025 },
121250 "type": "array"
1310025 },
140125 {
150125 "type": "null"
160125 }
1710025 ],
1810025}
query3 / 3
1116n/a{
2116n/a "anyOf": [
3110n/a {
4110n/a "type": "string"
5110n/a },
66110 {
76110 "type": "null"
86110 }
9116n/a ],
10116n/a}
page2 / 2
112229{
21228 "exclusiveMinimum": 0,
313021 "type": "integer"
412229}
limit2 / 2
117516{
21753 "exclusiveMinimum": 0,
317813 "type": "integer"
417516}
sorting4 / 6
16922{
26922 "anyOf": [
36922 {
46922 "items": {
519561 "$ref": "#/components/schemas/CustomerCustomerMeterSortProperty"
66922 },
7910 "type": "array"
86922 },
9091 {
10091 "type": "null"
11091 }
126922 ],
136922}
Referenced Components (1)3 of 3 keywords
CustomerCustomerMeterSortProperty3 of 3 keywords
119561{
219561 "enum": [
312n/a "created_at",
411n/a "-created_at",
56n/a "modified_at",
640n/a "-modified_at",
78n/a "meter_id",
811n/a "-meter_id",
922n/a "meter_name",
1013n/a "-meter_name",
1112n/a "consumed_units",
129n/a "-consumed_units",
1313n/a "credited_units",
1418n/a "-credited_units",
159n/a "balance",
1611n/a "-balance"
1719561 ],
18238n/a "type": "string"
1919561}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response1485ms
422Validation Error687ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1612ms
Examples3 / 3 used
Query
1page
10limit
[ "-modified_at" ]sorting
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13030{
23030 "format": "uuid4",
3303n/a "type": "string"
43030}
Responses1 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Customer meter not found.2524ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized512ms
Query Parameters7 of 7 keywords covered
platform2 / 2
CustomerOAuthPlatform
#validinvalidschema
136621{
236621 "enum": [
3293n/a "github",
473n/a "discord"
536621 ],
6387n/a "type": "string"
736621}
customer_id2 / 2
137312{
237312 "format": "uuid",
3385n/a "type": "string"
437312}
return_to3 / 3
172n/a{
272n/a "anyOf": [
369n/a {
469n/a "type": "string"
569n/a },
6369 {
7369 "type": "null"
8369 }
972n/a ],
1072n/a}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response3183ms
422Validation Error423ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized332ms
Query Parameters7 of 7 keywords covered
state1 / 1
#validinvalidschema
129n/a{
229n/a "type": "string"
329n/a}
code3 / 3
18n/a{
28n/a "anyOf": [
37n/a {
47n/a "type": "string"
57n/a },
617 {
717 "type": "null"
817 }
98n/a ],
108n/a}
error3 / 3
111n/a{
211n/a "anyOf": [
39n/a {
49n/a "type": "string"
59n/a },
629 {
729 "type": "null"
829 }
911n/a ],
1011n/a}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error14ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error29733ms
Query Parameters21 of 34 keywords covered
product_id3 / 7
#validinvalidschema
150218{
250218 "anyOf": [
30520 {
400 "format": "uuid4",
50n/a "type": "string",
60520 },
750218 {
850218 "items": {
95450 "format": "uuid4",
10545n/a "type": "string",
1150218 },
125200 "type": "array"
1350218 },
140520 {
150520 "type": "null"
160520 }
1750218 ],
1850218}
product_billing_type4 / 7
120226{
220226 "anyOf": [
30228 {
40228 "$ref": "#/components/schemas/ProductBillingType"
50228 },
620226 {
720226 "items": {
848928 "$ref": "#/components/schemas/ProductBillingType"
920226 },
102280 "type": "array"
1120226 },
120228 {
130228 "type": "null"
140228 }
1520226 ],
1620226}
Referenced Components (1)3 of 3 keywords
ProductBillingType3 of 3 keywords
1489256{
2489256 "enum": [
3257n/a "one_time",
4232n/a "recurring"
5489256 ],
6505n/a "type": "string"
7489256}
subscription_id3 / 7
13334{
23334 "anyOf": [
30337 {
400 "format": "uuid4",
50n/a "type": "string"
60337 },
73334 {
83334 "items": {
96210 "format": "uuid4",
10621n/a "type": "string"
113334 },
123370 "type": "array"
133334 },
140337 {
150337 "type": "null"
160337 }
173334 ],
183334}
query3 / 3
1192n/a{
2192n/a "anyOf": [
3176n/a {
4176n/a "type": "string"
5176n/a },
616176 {
716176 "type": "null"
816176 }
9192n/a ],
10192n/a}
page2 / 2
125626{
22562 "exclusiveMinimum": 0,
325824 "type": "integer"
425626}
limit2 / 2
129123{
22912 "exclusiveMinimum": 0,
329321 "type": "integer"
429123}
sorting4 / 6
111926{
211926 "anyOf": [
311926 {
411926 "items": {
542828 "$ref": "#/components/schemas/CustomerOrderSortProperty"
611926 },
71450 "type": "array"
811926 },
90145 {
100145 "type": "null"
110145 }
1211926 ],
1311926}
Referenced Components (1)3 of 3 keywords
CustomerOrderSortProperty3 of 3 keywords
142828{
242828 "enum": [
340n/a "created_at",
483n/a "-created_at",
557n/a "amount",
638n/a "-amount",
743n/a "net_amount",
833n/a "-net_amount",
929n/a "product",
1045n/a "-product",
1121n/a "subscription",
1239n/a "-subscription"
1342828 ],
14430n/a "type": "string"
1542828}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response42711ms
422Validation Error703ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1032ms
500Internal Server Error111408ms
Examples3 / 3 used
Query
1page
10limit
[ "-created_at" ]sorting
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13080{
23080 "format": "uuid4",
3308n/a "type": "string"
43080}
Responses1 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Order not found.2454ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized632ms
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
16300{
26300 "format": "uuid4",
3630n/a "type": "string"
46300}
Body29 of 29 keywords covered
application/json29 / 29
CustomerOrderUpdate
140458{
241245 "properties": {
340941 "billing_address": {
440941 "anyOf": [
5313137 {
6313137 "$ref": "#/components/schemas/AddressInput"
7313137 },
896354 {
996354 "type": "null"
1096354 }
1140941 ],
1240941 },
134524 "billing_name": {
144524 "anyOf": [
15130326 {
16130326 "type": "string"
17130326 },
18322134 {
19322134 "type": "null"
20322134 }
214524 ],
224524 }
2341245 },
244498 "required": [
254561 "billing_name",
264507 "billing_address"
274498 ],
284575 "type": "object"
2940458}
Referenced Components (1)28 of 28 keywords
AddressInput28 of 28 keywords
1313137{
231435 "properties": {
32954 "city": {
42954 "anyOf": [
513286 {
613286 "type": "string"
713286 },
828217 {
928217 "type": "null"
1028217 }
112954 ],
122954 },
133426 "country": {
143426 "enum": [
1518n/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",
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",
572n/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",
1012n/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",
1328n/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",
1473n/a "LY",
1481n/a "MA",
1491n/a "MC",
1501n/a "MD",
1511n/a "ME",
1521n/a "MF",
1531n/a "MG",
1541n/a "MH",
1557n/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",
1762n/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",
1892n/a "PK",
1901n/a "PL",
1911n/a "PM",
1923n/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",
20110n/a "RS",
2021n/a "RW",
2031n/a "SA",
2042n/a "SB",
2051n/a "SC",
2061n/a "SD",
2072n/a "SE",
2081n/a "SG",
2091n/a "SH",
2101n/a "SI",
2112n/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",
2283n/a "TJ",
2291n/a "TK",
2301n/a "TL",
2311n/a "TM",
2321n/a "TN",
2338n/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",
2462n/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",
2553n/a "YT",
2561n/a "ZA",
2571n/a "ZM",
2581n/a "ZW"
2593426 ],
2603435 "type": "string",
2613426 },
26230111 "line1": {
26330111 "anyOf": [
26417295 {
26517295 "type": "string"
26617295 },
26728428 {
26828428 "type": "null"
26928428 }
27030111 ],
27130111 },
2722966 "line2": {
2732966 "anyOf": [
2748294 {
2758294 "type": "string"
2768294 },
27728814 {
27828814 "type": "null"
27928814 }
2802966 ],
2812966 },
28229911 "postal_code": {
28329911 "anyOf": [
2847303 {
2857303 "type": "string"
2867303 },
28729218 {
28829218 "type": "null"
28929218 }
29029911 ],
29129911 },
2923004 "state": {
2933004 "anyOf": [
29412292 {
29512292 "type": "string"
29612292 },
29728816 {
29828816 "type": "null"
29928816 }
3003004 ],
3013004 }
30231435 },
3033482 "required": [
3043482 "country"
3053482 ],
306350100 "type": "object"
307313137}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Order not found.3975ms
422Validation Error1303ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized72ms
500Internal Server Error5774ms
400Bad Request913ms
Examples3 / 3 used
Body: application/json
"US"AddressInput.country.examples[0]
"SE"AddressInput.country.examples[1]
"FR"AddressInput.country.examples[2]
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
133411{
233411 "format": "uuid4",
3345n/a "type": "string"
433411}
Body11 of 12 keywords covered
application/json11 / 12
CustomerOrderConfirmPayment
129125{
26620 "properties": {
3534 "confirmation_token_id": {
4534 "anyOf": [
51839 {
61839 "type": "string"
71839 },
83522 {
93522 "type": "null"
103522 }
11534 ],
12534 },
13464 "payment_method_id": {
14464 "anyOf": [
153713 {
16370 "format": "uuid4",
173713 "type": "string"
183713 },
19941 {
20941 "type": "null"
21941 }
22464 ],
23464 },
244712 "payment_processor": {
254712 "$ref": "#/components/schemas/PaymentProcessor",
264712 }
276620 },
283115 "type": "object"
2929125}
Referenced Components (1)3 of 3 keywords
PaymentProcessor3 of 3 keywords
14712{
24712 "enum": [
347n/a "stripe"
44712 ],
5545 "type": "string"
64712}
Responses2 of 4 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Order not found.106ms
409Payment already in progress.0never seen
422Order not eligible for retry or payment confirmation failed.3144ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized162ms
400Bad Request53ms
Examples1 / 1 used
Body: application/json
"stripe"CustomerOrderConfirmPayment.payment_processor
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
130511{
230511 "format": "uuid4",
3316n/a "type": "string"
430511}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Order not found.2614ms
422Validation Error113ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized442ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13155{
23155 "format": "uuid4",
3320n/a "type": "string"
43155}
Responses1 of 2 documented received
codedescriptionhitsavg
202Successful Response0never seen
422Order is not paid or is missing billing name or address.53ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized513ms
404Not Found2646ms
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13240{
23240 "format": "uuid4",
3324n/a "type": "string"
43240}
Responses1 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Order not found.2915ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized332ms
Path Parameters1 of 1 keywords covered
slug1 / 1
#validinvalidschema
15n/a{
25n/a "type": "string"
35n/a}
Responses1 of 3 documented received
codedescriptionhitsavg
200Successful Response510ms
404Organization not found.0never seen
422Validation Error0never seen
Query Parameters8 of 8 keywords covered
subscription_id4 / 4
#validinvalidschema
128718{
228718 "anyOf": [
328520 {
428518 "format": "uuid4",
5303n/a "type": "string"
628520 },
72303 {
82303 "type": "null"
92303 }
1028718 ],
1128718}
order_id4 / 4
116018{
216018 "anyOf": [
315622 {
415618 "format": "uuid4",
5174n/a "type": "string"
615622 },
74174 {
84174 "type": "null"
94174 }
1016018 ],
1116018}
Responses3 of 5 documented received
codedescriptionhitsavg
200Successful Response0never seen
401Authentication required1722ms
403Not permitted or seat-based pricing not enabled0never seen
404Subscription or order not found2526ms
422Validation Error243ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1604ms
Body30 of 30 keywords covered
application/json30 / 30
SeatAssign
#validinvalidschema
119361{
218555 "properties": {
32046 "checkout_id": {
42046 "anyOf": [
519119 {
61912 "format": "uuid",
719317 "type": "string"
819119 },
913197 {
1013197 "type": "null"
1113197 }
122046 ],
132046 },
1412411 "customer_id": {
1512411 "anyOf": [
168847 {
17882 "format": "uuid",
189045 "type": "string"
198847 },
203699 {
213699 "type": "null"
223699 }
2312411 ],
2412411 },
251106 "email": {
261106 "anyOf": [
279917 {
281142 "format": "email",
2910115 "type": "string"
309917 },
3111105 {
3211105 "type": "null"
3311105 }
341106 ],
351106 },
3611516 "external_customer_id": {
3711516 "anyOf": [
3820111 {
3920111 "type": "string"
4020111 },
419536 {
429536 "type": "null"
439536 }
4411516 ],
4511516 },
461115 "immediate_claim": {
471115 "type": "boolean"
481115 },
491184 "metadata": {
501184 "anyOf": [
513092 {
521n/a "additionalProperties": true,
533092 "type": "object"
543092 },
558834 {
568834 "type": "null"
578834 }
581184 ],
591184 },
601206 "order_id": {
611206 "anyOf": [
627848 {
63782 "format": "uuid",
648046 "type": "string"
657848 },
664284 {
674284 "type": "null"
684284 }
691206 ],
701206 },
7113811 "subscription_id": {
7213811 "anyOf": [
7311633 {
741167 "format": "uuid",
7512326 "type": "string"
7611633 },
7722127 {
7822127 "type": "null"
7922127 }
8013811 ],
8113811 }
8218555 },
832486 "type": "object"
8419361}
Responses3 of 6 documented received
codedescriptionhitsavg
200Successful Response0never seen
400No available seats or customer already has a seat805ms
401Authentication required494ms
403Not permitted or seat-based pricing not enabled0never seen
404Subscription, order, or customer not found0never seen
422Validation Error2694ms
Examples1 / 1 used
Body: application/json
falseSeatAssign.immediate_claim
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response2615ms
401Authentication required2632ms
Path Parameters2 of 2 keywords covered
seat_id2 / 2
#validinvalidschema
129013{
229013 "format": "uuid4",
3303n/a "type": "string"
429013}
Responses3 of 5 documented received
codedescriptionhitsavg
200Successful Response0never seen
401Authentication required362ms
403Not permitted or seat-based pricing not enabled0never seen
404Seat not found2545ms
422Validation Error133ms
Path Parameters2 of 2 keywords covered
seat_id2 / 2
#validinvalidschema
149110{
249110 "format": "uuid4",
3501n/a "type": "string"
449110}
Responses3 of 6 documented received
codedescriptionhitsavg
200Successful Response0never seen
400Seat is not pending or already claimed0never seen
401Authentication required543ms
403Not permitted or seat-based pricing not enabled0never seen
404Seat not found4377ms
422Validation Error103ms
Query Parameters17 of 23 keywords covered
product_id3 / 7
#validinvalidschema
15214{
25214 "anyOf": [
30525 {
400 "format": "uuid4",
50n/a "type": "string",
60525 },
75214 {
85214 "items": {
95660 "format": "uuid4",
10566n/a "type": "string",
115214 },
125250 "type": "array"
135214 },
140525 {
150525 "type": "null"
160525 }
175214 ],
185214}
active3 / 3
11616{
21616 "anyOf": [
315710 {
415710 "type": "boolean"
515710 },
64163 {
74163 "type": "null"
84163 }
91616 ],
101616}
query3 / 3
1149n/a{
2149n/a "anyOf": [
3147n/a {
4147n/a "type": "string"
5147n/a },
62147 {
72147 "type": "null"
82147 }
9149n/a ],
10149n/a}
page2 / 2
123419{
22342 "exclusiveMinimum": 0,
323617 "type": "integer"
423419}
limit2 / 2
124325{
22433 "exclusiveMinimum": 0,
324622 "type": "integer"
424325}
sorting4 / 6
112014{
212014 "anyOf": [
312014 {
412014 "items": {
545116 "$ref": "#/components/schemas/CustomerSubscriptionSortProperty"
612014 },
71340 "type": "array"
812014 },
90134 {
100134 "type": "null"
110134 }
1212014 ],
1312014}
Referenced Components (1)3 of 3 keywords
CustomerSubscriptionSortProperty3 of 3 keywords
145116{
245116 "enum": [
335n/a "started_at",
469n/a "-started_at",
549n/a "amount",
632n/a "-amount",
733n/a "status",
836n/a "-status",
957n/a "organization",
1047n/a "-organization",
1149n/a "product",
1244n/a "-product"
1345116 ],
14453n/a "type": "string"
1545116}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response3768ms
422Validation Error533ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1912ms
500Internal Server Error61409ms
Examples3 / 3 used
Query
1page
10limit
[ "-started_at" ]sorting
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
129811{
229811 "format": "uuid4",
3309n/a "type": "string"
429811}
Responses2 of 4 documented received
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.2454ms
422Validation Error113ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized532ms
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13050{
23050 "format": "uuid4",
3305n/a "type": "string"
43050}
Responses1 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Customer subscription was not found.2674ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized382ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13461{
23461 "format": "uuid4",
3347n/a "type": "string"
43461}
Body25 of 32 keywords covered
application/json25 / 32
CustomerSubscriptionUpdate
129530{
229530 "anyOf": [
3201124 {
4201124 "$ref": "#/components/schemas/CustomerSubscriptionUpdateProduct"
5201124 },
625300 {
725300 "$ref": "#/components/schemas/CustomerSubscriptionUpdateSeats"
825300 },
929530 {
1029530 "$ref": "#/components/schemas/CustomerSubscriptionCancel"
1129530 }
1229530 ]
1329530}
Referenced Components (5)29 of 39 keywords
CustomerCancellationReason3 of 3 keywords
11921{
21921 "enum": [
32n/a "customer_service",
43n/a "low_quality",
51n/a "missing_features",
61n/a "switched_service",
73n/a "too_complex",
86n/a "too_expensive",
92n/a "unused",
101n/a "other"
111921 ],
122020 "type": "string"
131921}
CustomerSubscriptionCancel15 of 15 keywords
129530{
24313 "properties": {
3374 "cancel_at_period_end": {
4374 "anyOf": [
51427 {
61427 "type": "boolean"
71427 },
82318 {
92318 "type": "null"
102318 }
11374 ],
12374 },
13494 "cancellation_comment": {
14494 "anyOf": [
15746 {
16746 "type": "string"
17746 },
184211 {
194211 "type": "null"
204211 }
21494 ],
22494 },
23355 "cancellation_reason": {
24355 "anyOf": [
251921 {
261921 "$ref": "#/components/schemas/CustomerCancellationReason"
271921 },
281624 {
291624 "type": "null"
301624 }
31355 ],
32355 }
334313 },
3430817 "type": "object"
3529530}
CustomerSubscriptionUpdateProduct3 of 7 keywords
1201124{
22010 "properties": {
32010 "product_id": {
42010 "format": "uuid4",
52010 "type": "string"
62010 }
72010 },
8201107 "required": [
9201107 "product_id"
10201107 ],
1130817 "type": "object"
12201124}
CustomerSubscriptionUpdateSeats5 of 11 keywords
125300{
2250 "properties": {
340 "proration_behavior": {
440 "anyOf": [
522 {
622 "$ref": "#/components/schemas/SubscriptionProrationBehavior"
722 },
822 {
922 "type": "null"
1022 }
1140 ],
1240 },
13250 "seats": {
14250 "minimum": 1.0,
15250 "type": "integer"
16250 }
17250 },
1825283 "required": [
1925283 "seats"
2025283 ],
2130817 "type": "object"
2225300}
SubscriptionProrationBehavior3 of 3 keywords
122{
222 "enum": [
31n/a "invoice",
41n/a "prorate"
522 ],
622 "type": "string"
722}
Responses2 of 4 documented received
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.2815ms
422Validation Error494ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized143ms
400Bad Request33ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13254{
23254 "format": "uuid4",
3329n/a "type": "string"
43254}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Customer subscription was not found.2944ms
422Validation Error45ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized312ms
Query Parameters8 of 10 keywords covered
page2 / 2
#validinvalidschema
120452{
220412 "exclusiveMinimum": 0,
321640 "type": "integer"
420452}
limit2 / 2
124530{
22457 "exclusiveMinimum": 0,
325223 "type": "integer"
424530}
sorting4 / 6
19147{
29147 "anyOf": [
39147 {
49147 "items": {
5394116 "$ref": "#/components/schemas/CustomerWalletSortProperty"
69147 },
71380 "type": "array"
89147 },
90138 {
100138 "type": "null"
110138 }
129147 ],
139147}
Referenced Components (1)3 of 3 keywords
CustomerWalletSortProperty3 of 3 keywords
1394116{
2394116 "enum": [
3102n/a "created_at",
4107n/a "-created_at",
581n/a "balance",
6104n/a "-balance"
7394116 ],
8481n/a "type": "string"
9394116}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response2935ms
422Validation Error793ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1652ms
500Internal Server Error251368ms
Examples3 / 3 used
Query
1page
10limit
[ "-created_at" ]sorting
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13035{
23035 "format": "uuid4",
3308n/a "type": "string"
43035}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Wallet not found.2574ms
422Validation Error53ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized462ms
customer-seats 6 operations 5 covered 1 partial 0 uncovered 0 not measured 97% #
Query Parameters8 of 8 keywords covered
subscription_id4 / 4
#validinvalidschema
130034{
230034 "anyOf": [
329737 {
429734 "format": "uuid4",
5331n/a "type": "string"
629737 },
73331 {
83331 "type": "null"
93331 }
1030034 ],
1130034}
order_id4 / 4
114532{
214532 "anyOf": [
314037 {
414032 "format": "uuid4",
5172n/a "type": "string"
614037 },
75172 {
85172 "type": "null"
95172 }
1014532 ],
1114532}
Responses3 of 5 documented received
codedescriptionhitsavg
200Successful Response0never seen
401Authentication required0never seen
403Not permitted or seat-based pricing not enabled1012ms
404Subscription or order not found2778ms
422Validation Error445ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1966ms
Body30 of 30 keywords covered
application/json30 / 30
SeatAssign
#validinvalidschema
118548{
217743 "properties": {
31986 "checkout_id": {
41986 "anyOf": [
519410 {
61942 "format": "uuid",
71968 "type": "string"
819410 },
94200 {
104200 "type": "null"
114200 }
121986 ],
131986 },
141106 "customer_id": {
151106 "anyOf": [
168234 {
17822 "format": "uuid",
188432 "type": "string"
198234 },
202888 {
212888 "type": "null"
222888 }
231106 ],
241106 },
251086 "email": {
261086 "anyOf": [
279717 {
281122 "format": "email",
299915 "type": "string"
309717 },
3111103 {
3211103 "type": "null"
3311103 }
341086 ],
351086 },
361014 "external_customer_id": {
371014 "anyOf": [
384263 {
394263 "type": "string"
404263 },
415946 {
425946 "type": "null"
435946 }
441014 ],
451014 },
461155 "immediate_claim": {
471155 "type": "boolean"
481155 },
49974 "metadata": {
50974 "anyOf": [
512279 {
521n/a "additionalProperties": true,
532279 "type": "object"
542279 },
557526 {
567526 "type": "null"
577526 }
58974 ],
59974 },
601136 "order_id": {
611136 "anyOf": [
628435 {
63842 "format": "uuid",
648633 "type": "string"
658435 },
662990 {
672990 "type": "null"
682990 }
691136 ],
701136 },
711256 "subscription_id": {
721256 "anyOf": [
7310922 {
741092 "format": "uuid",
7511120 "type": "string"
7610922 },
7716115 {
7816115 "type": "null"
7916115 }
801256 ],
811256 }
8217743 },
832285 "type": "object"
8418548}
Responses3 of 6 documented received
codedescriptionhitsavg
200Successful Response0never seen
400No available seats or customer already has a seat855ms
401Authentication required for direct subscription or order assignment0never seen
403Not permitted or seat-based pricing not enabled0never seen
404Subscription, order, checkout, or customer not found1313ms
422Validation Error2875ms
Examples1 / 1 used
Body: application/json
falseSeatAssign.immediate_claim
Body4 of 4 keywords covered
application/json4 / 4
SeatClaim
#validinvalidschema
140182{
240124 "properties": {
340124 "invitation_token": {
440124 "type": "string"
540124 }
640124 },
742546 "required": [
842546 "invitation_token"
942546 ],
1047112 "type": "object"
1140182}
Responses2 of 4 documented received
codedescriptionhitsavg
200Successful Response0never seen
400Invalid, expired, or already claimed token3965ms
403Seat-based pricing not enabled for organization0never seen
422Validation Error982ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error101307ms
Path Parameters1 of 1 keywords covered
invitation_token1 / 1
#validinvalidschema
1252n/a{
2252n/a "type": "string"
3252n/a}
Responses1 of 5 documented received
codedescriptionhitsavg
200Successful Response0never seen
400Invalid or expired invitation token0never seen
403Seat-based pricing not enabled for organization0never seen
404Seat not found2524ms
422Validation Error0never seen
Path Parameters1 of 2 keywords covered
seat_id1 / 2
#validinvalidschema
13020{
23020 "format": "uuid4",
3302n/a "type": "string"
43020}
Responses2 of 5 documented received
codedescriptionhitsavg
200Successful Response0never seen
401Authentication required0never seen
403Not permitted or seat-based pricing not enabled293ms
404Seat not found2737ms
422Validation Error0never seen
Path Parameters2 of 2 keywords covered
seat_id2 / 2
#validinvalidschema
152120{
252120 "format": "uuid4",
3541n/a "type": "string"
452120}
Responses3 of 6 documented received
codedescriptionhitsavg
200Successful Response0never seen
400Seat is not pending or already claimed0never seen
401Authentication required0never seen
403Not permitted or seat-based pricing not enabled283ms
404Seat not found4938ms
422Validation Error206ms
customer-sessions 1 operation 0 covered 1 partial 0 uncovered 0 not measured 95% #
Body23 of 24 keywords covered
application/json23 / 24
#validinvalidschema
135162{
235162 "anyOf": [
3207206 {
4207206 "$ref": "#/components/schemas/CustomerSessionCustomerIDCreate"
5207206 },
6144269 {
7144269 "$ref": "#/components/schemas/CustomerSessionCustomerExternalIDCreate"
8144269 }
935162 ],
1035162}
Referenced Components (2)26 of 27 keywords
CustomerSessionCustomerExternalIDCreate13 of 13 keywords
1144269{
224939 "properties": {
315319 "external_customer_id": {
415319 "type": "string"
515319 },
618226 "return_url": {
718226 "anyOf": [
814167 {
91437 "format": "uri",
101482 "maxLength": 2083,
111473 "minLength": 1,
1215058 "type": "string"
1314167 },
1441167 {
1541167 "type": "null"
1641167 }
1718226 ],
1818226 }
1924939 },
20172231 "required": [
21172231 "external_customer_id"
22172231 ],
2340310 "type": "object"
24144269}
CustomerSessionCustomerIDCreate13 of 14 keywords
1207206{
228931 "properties": {
32167 "customer_id": {
42160 "format": "uuid4",
52167 "type": "string"
62167 },
718226 "return_url": {
818226 "anyOf": [
914167 {
101437 "format": "uri",
111482 "maxLength": 2083,
121473 "minLength": 1,
1315058 "type": "string"
1414167 },
1541167 {
1641167 "type": "null"
1741167 }
1818226 ],
1918226 }
2028931 },
21223180 "required": [
22223180 "customer_id"
23223180 ],
2440310 "type": "object"
25207206}
Responses1 of 2 documented received
codedescriptionhitsavg
201Customer session created.0never seen
422Validation Error4546ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request978ms
401Unauthorized372ms
500Internal Server Error41436ms
Examples2 / 2 used
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 86% #
Query Parameters21 of 37 keywords covered
organization_id2 / 7
#validinvalidschema
18430{
28430 "anyOf": [
30843 {
400 "format": "uuid4",
50n/a "type": "string",
60843 },
78430 {
88430 "items": {
98430 "format": "uuid4",
10843n/a "type": "string",
118430 },
128430 "type": "array"
138430 },
140843 {
150843 "type": "null"
160843 }
178430 ],
188430}
email3 / 3
1379n/a{
2379n/a "anyOf": [
3372n/a {
4372n/a "type": "string"
5372n/a },
67372 {
77372 "type": "null"
87372 }
9379n/a ],
10379n/a}
query3 / 3
1202n/a{
2202n/a "anyOf": [
3199n/a {
4199n/a "type": "string"
5199n/a },
63199 {
73199 "type": "null"
83199 }
9202n/a ],
10202n/a}
include_members1 / 1
135316{
235316 "type": "boolean"
335316}
page2 / 2
134023{
23402 "exclusiveMinimum": 0,
334221 "type": "integer"
434023}
limit2 / 2
135532{
23552 "exclusiveMinimum": 0,
335730 "type": "integer"
435532}
sorting4 / 6
117624{
217624 "anyOf": [
317624 {
417624 "items": {
561126 "$ref": "#/components/schemas/CustomerSortProperty"
617624 },
72000 "type": "array"
817624 },
90200 {
100200 "type": "null"
110200 }
1217624 ],
1317624}
Referenced Components (1)3 of 3 keywords
CustomerSortProperty3 of 3 keywords
161126{
261126 "enum": [
3125n/a "created_at",
4142n/a "-created_at",
582n/a "email",
674n/a "-email",
796n/a "name",
892n/a "-name"
961126 ],
10617n/a "type": "string"
1161126}
metadata4 / 13
MetadataQuery
11390{
21390 "anyOf": [
31390 {
41390 "additionalProperties": {
53910 "anyOf": [
6215176 {
7215176 "type": "string"
8215176 },
90391 {
100391 "type": "integer"
110391 },
120391 {
130391 "type": "boolean"
140391 },
15176215 {
161760 "items": {
1710890 "type": "string"
181760 },
19176215 "type": "array"
20176215 },
210391 {
220176 "items": {
2301089 "type": "integer"
240176 },
25176215 "type": "array"
260391 },
270391 {
280176 "items": {
2901089 "type": "boolean"
300176 },
31176215 "type": "array"
320391 }
333910 ]
341390 },
351390 "type": "object"
361390 },
370139 {
380139 "type": "null"
390139 }
401390 ],
411390}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response6707ms
422Validation Error675ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized922ms
500Internal Server Error141507ms
Examples4 / 6 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
falseinclude_members
1page
10limit
[ "-created_at" ]sorting
Query Parameters1 of 1 keywords covered
include_members1 / 1
#validinvalidschema
158020{
258020 "type": "boolean"
358020}
Body73 of 76 keywords covered
application/json73 / 76
CustomerCreate
1695123{
2696117 "properties": {
353743 "billing_address": {
453743 "anyOf": [
5327253 {
6327253 "$ref": "#/components/schemas/AddressInput"
7327253 },
8210370 {
9210370 "type": "null"
10210370 }
1153743 ]
1253743 },
1380210 "email": {
148075 "format": "email",
158075 "type": "string"
1680210 },
1751710 "external_id": {
1851710 "anyOf": [
1948641 {
2048641 "type": "string"
2148641 },
2231496 {
2331496 "type": "null"
2431496 }
2551710 ],
2651710 },
275368 "metadata": {
281293 "additionalProperties": {
293713 "anyOf": [
30151223 {
311540 "maxLength": 500,
321513 "minLength": 1,
33154220 "type": "string"
34151223 },
3578296 {
3678296 "type": "integer"
3778296 },
38113261 {
39113261 "type": "number"
40113261 },
41107267 {
42107267 "type": "boolean"
43107267 }
443713 ]
451293 },
465390 "maxProperties": 50,
471302 "propertyNames": {
483731 "maxLength": 40,
493731 "minLength": 1
501302 },
515395 "type": "object"
525368 },
535425 "name": {
545425 "anyOf": [
5550047 {
565001 "maxLength": 256,
5750146 "type": "string"
5850047 },
5942505 {
6042505 "type": "null"
6142505 }
625425 ],
635425 },
647994 "organization_id": {
657994 "anyOf": [
667985 {
677980 "format": "uuid4",
687985 "type": "string",
697985 },
701802 {
711802 "type": "null"
721802 }
737994 ],
747994 },
7554721 "owner": {
7654721 "anyOf": [
7797471 {
7897471 "$ref": "#/components/schemas/OwnerCreate"
7997471 },
80450118 {
81450118 "type": "null"
82450118 }
8354721 ],
8454721 },
8554218 "tax_id": {
8654218 "anyOf": [
87458102 {
884711 "maxItems": 2,
894711 "minItems": 2,
9046012 "prefixItems": [
914666 {
924666 "type": "string"
934666 },
944647 {
954647 "$ref": "#/components/schemas/TaxIDFormat"
964647 }
9746012 ],
9847288 "type": "array"
99458102 },
10084476 {
10184476 "type": "null"
10284476 }
10354218 ],
10454218 }
105696117 },
1068121 "required": [
1078121 "email"
1088121 ],
1098135 "type": "object"
110695123}
Referenced Components (3)48 of 48 keywords
AddressInput28 of 28 keywords
1327253{
232934 "properties": {
332211 "city": {
432211 "anyOf": [
526307 {
626307 "type": "string"
726307 },
829637 {
929637 "type": "null"
1029637 }
1132211 ],
1232211 },
133556 "country": {
143556 "enum": [
155n/a "AD",
162n/a "AE",
171n/a "AF",
181n/a "AG",
191n/a "AI",
201n/a "AL",
211n/a "AM",
222n/a "AO",
231n/a "AQ",
241n/a "AR",
256n/a "AS",
261n/a "AT",
273n/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",
363n/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",
482n/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",
632n/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",
773n/a "EE",
781n/a "EG",
791n/a "EH",
802n/a "ER",
811n/a "ES",
822n/a "ET",
832n/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",
933n/a "GF",
941n/a "GG",
951n/a "GH",
961n/a "GI",
971n/a "GL",
981n/a "GM",
992n/a "GN",
1001n/a "GP",
1012n/a "GQ",
1021n/a "GR",
1034n/a "GS",
1041n/a "GT",
1051n/a "GU",
1061n/a "GW",
1071n/a "GY",
1081n/a "HK",
1092n/a "HM",
1101n/a "HN",
1111n/a "HR",
1121n/a "HT",
1131n/a "HU",
1141n/a "ID",
1152n/a "IE",
1162n/a "IL",
1171n/a "IM",
1181n/a "IN",
1191n/a "IO",
1201n/a "IQ",
1211n/a "IS",
1221n/a "IT",
1232n/a "JE",
1241n/a "JM",
1251n/a "JO",
1261n/a "JP",
1271n/a "KE",
1281n/a "KG",
1292n/a "KH",
1302n/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",
1452n/a "LU",
1461n/a "LV",
1471n/a "LY",
1482n/a "MA",
1493n/a "MC",
1501n/a "MD",
1511n/a "ME",
1521n/a "MF",
1532n/a "MG",
1542n/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",
1642n/a "MT",
1651n/a "MU",
1665n/a "MV",
1671n/a "MW",
1682n/a "MX",
1697n/a "MY",
1701n/a "MZ",
1711n/a "NA",
1721n/a "NC",
1731n/a "NE",
1742n/a "NF",
1751n/a "NG",
1761n/a "NI",
1771n/a "NL",
1781n/a "NO",
1791n/a "NP",
1802n/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",
1972n/a "PY",
1981n/a "QA",
1991n/a "RE",
2001n/a "RO",
2011n/a "RS",
2021n/a "RW",
2032n/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",
2162n/a "SO",
2171n/a "SR",
2181n/a "SS",
2192n/a "ST",
2201n/a "SV",
2211n/a "SX",
2222n/a "SZ",
2232n/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",
2342n/a "TR",
2351n/a "TT",
2361n/a "TV",
2373n/a "TW",
2381n/a "TZ",
2391n/a "UA",
2401n/a "UG",
2412n/a "UM",
24236n/a "US",
2432n/a "UY",
2443n/a "UZ",
2451n/a "VA",
2462n/a "VC",
2471n/a "VE",
2481n/a "VG",
2491n/a "VI",
2501n/a "VN",
2511n/a "VU",
2522n/a "WF",
2531n/a "WS",
2541n/a "YE",
2551n/a "YT",
2561n/a "ZA",
2572n/a "ZM",
2582n/a "ZW"
2593556 ],
2603565 "type": "string",
2613556 },
2623225 "line1": {
2633225 "anyOf": [
26424303 {
26524303 "type": "string"
26624303 },
26729829 {
26829829 "type": "null"
26929829 }
2703225 ],
2713225 },
2723254 "line2": {
2733254 "anyOf": [
27432297 {
27532297 "type": "string"
27632297 },
27729336 {
27829336 "type": "null"
27929336 }
2803254 ],
2813254 },
2823204 "postal_code": {
2833204 "anyOf": [
28415309 {
28515309 "type": "string"
28615309 },
28730519 {
28830519 "type": "null"
28930519 }
2903204 ],
2913204 },
2923144 "state": {
2933144 "anyOf": [
29424294 {
29524294 "type": "string"
29624294 },
29729028 {
29829028 "type": "null"
29929028 }
3003144 ],
3013144 }
30232934 },
3033613 "required": [
3043613 "country"
3053613 ],
306364216 "type": "object"
307327253}
OwnerCreate17 of 17 keywords
197471{
26215 "properties": {
3546 "email": {
4546 "anyOf": [
54614 {
6582 "format": "email",
74812 "type": "string"
84614 },
9852 {
10852 "type": "null"
11852 }
12546 ],
13546 },
14574 "external_id": {
15574 "anyOf": [
164912 {
174912 "type": "string"
184912 },
19853 {
20853 "type": "null"
21853 }
22574 ],
23574 },
24625 "name": {
25625 "anyOf": [
265314 {
27531 "maxLength": 256,
285413 "type": "string"
295314 },
30958 {
31958 "type": "null"
32958 }
33625 ],
34625 }
356215 },
36112456 "type": "object"
3797471}
TaxIDFormat3 of 3 keywords
14647{
24647 "enum": [
38n/a "ad_nrt",
40n/a "ae_trn",
53n/a "ar_cuit",
61n/a "au_abn",
70n/a "au_arn",
80n/a "bg_uic",
90n/a "bh_vat",
102n/a "bo_tin",
110n/a "br_cnpj",
120n/a "br_cpf",
13371n/a "ca_bn",
142n/a "ca_gst_hst",
150n/a "ca_pst_bc",
164n/a "ca_pst_mb",
171n/a "ca_pst_sk",
180n/a "ca_qst",
198n/a "ch_uid",
200n/a "ch_vat",
210n/a "cl_tin",
222n/a "cn_tin",
231n/a "co_nit",
240n/a "cr_tin",
252n/a "de_stn",
261n/a "do_rcn",
271n/a "ec_ruc",
287n/a "eg_tin",
290n/a "es_cif",
300n/a "eu_oss_vat",
312n/a "eu_vat",
320n/a "gb_vat",
330n/a "ge_vat",
340n/a "hk_br",
351n/a "hr_oib",
360n/a "hu_tin",
370n/a "id_npwp",
380n/a "il_vat",
393n/a "in_gst",
401n/a "is_vat",
411n/a "jp_cn",
420n/a "jp_rn",
431n/a "jp_trn",
441n/a "ke_pin",
450n/a "kr_brn",
460n/a "kz_bin",
470n/a "li_uid",
485n/a "mx_rfc",
491n/a "my_frp",
502n/a "my_itn",
514n/a "my_sst",
520n/a "ng_tin",
530n/a "no_vat",
541n/a "no_voec",
550n/a "nz_gst",
560n/a "om_vat",
573n/a "pe_ruc",
582n/a "ph_tin",
590n/a "ro_tin",
607n/a "rs_pib",
610n/a "ru_inn",
620n/a "ru_kpp",
630n/a "sa_vat",
641n/a "sg_gst",
651n/a "sg_uen",
660n/a "si_tin",
675n/a "sv_nit",
680n/a "th_vat",
690n/a "tr_tin",
702n/a "tw_vat",
711n/a "ua_vat",
723n/a "us_ein",
730n/a "uy_ruc",
740n/a "ve_rif",
750n/a "vn_tin",
762n/a "za_vat"
774647 ],
784656 "type": "string"
794647}
Responses2 of 2 documented received
codedescriptionhitsavg
201Customer created.71167ms
422Validation Error82512ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error5823ms
400Bad Request306ms
401Unauthorized63ms
Examples13 / 13 used
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 Parameters2 of 7 keywords covered
organization_id2 / 7
#validinvalidschema
14570{
24570 "anyOf": [
30457 {
400 "format": "uuid4",
50n/a "type": "string",
60457 },
74570 {
84570 "items": {
94570 "format": "uuid4",
10457n/a "type": "string",
114570 },
124570 "type": "array"
134570 },
140457 {
150457 "type": "null"
160457 }
174570 ],
184570}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response2786ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1792ms
Examples0 / 2 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
Path Parametersnot covered
external_idno coverage data
#validinvalidschema
10n/a{
20n/a "type": "string"
30n/a}
Expected Responses0 of 3 documented received
codedescriptionhitsavg
204Customer deleted.0never seen
404Customer not found.0never seen
422Validation Error0never seen
Path Parameters1 of 1 keywords covered
external_id1 / 1
#validinvalidschema
1294n/a{
2294n/a "type": "string"
3294n/a}
Query Parameters1 of 1 keywords covered
include_members1 / 1
110026{
210026 "type": "boolean"
310026}
Responses3 of 3 documented received
codedescriptionhitsavg
200Successful Response2336ms
404Customer not found.285ms
422Validation Error265ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized73ms
Examples1 / 1 used
Query
falseinclude_members
Path Parameters1 of 1 keywords covered
external_id1 / 1
#validinvalidschema
1574n/a{
2574n/a "type": "string"
3574n/a}
Query Parameters1 of 1 keywords covered
include_members1 / 1
14019{
24019 "type": "boolean"
34019}
Body52 of 54 keywords covered
application/json52 / 54
CustomerUpdateExternalID
146986{
234381 "properties": {
335941 "billing_address": {
435941 "anyOf": [
5269131 {
6269131 "$ref": "#/components/schemas/AddressInput"
7269131 },
890310 {
990310 "type": "null"
1090310 }
1135941 ]
1235941 },
133747 "email": {
143747 "anyOf": [
1535724 {
163783 "format": "email",
1736021 "type": "string"
1835724 },
1917364 {
2017364 "type": "null"
2117364 }
223747 ],
233747 },
2436911 "metadata": {
25196 "additionalProperties": {
266811 "anyOf": [
271762 {
28190 "maxLength": 500,
29172 "minLength": 1,
301960 "type": "string"
311762 },
322455 {
332455 "type": "integer"
342455 },
353049 {
363049 "type": "number"
373049 },
382158 {
392158 "type": "boolean"
402158 }
416811 ]
42196 },
433750 "maxProperties": 50,
44232 "propertyNames": {
45781 "maxLength": 40,
46781 "minLength": 1
47232 },
483755 "type": "object"
4936911 },
503705 "name": {
513705 "anyOf": [
5236411 {
533641 "maxLength": 256,
5436510 "type": "string"
5536411 },
566369 {
576369 "type": "null"
586369 }
593705 ],
603705 },
6135018 "tax_id": {
6235018 "anyOf": [
6333929 {
643521 "maxItems": 2,
653521 "minItems": 2,
6634112 "prefixItems": [
673476 {
683476 "type": "string"
693476 },
703457 {
713457 "$ref": "#/components/schemas/TaxIDFormat"
723457 }
7334112 ],
7435315 "type": "array"
7533929 },
7611357 {
7711357 "type": "null"
7811357 }
7935018 ],
8035018 }
8134381 },
825505 "type": "object"
8346986}
Referenced Components (2)31 of 31 keywords
AddressInput28 of 28 keywords
1269131{
227133 "properties": {
328311 "city": {
428311 "anyOf": [
54290 {
64290 "type": "string"
74290 },
827915 {
927915 "type": "null"
1027915 }
1128311 ],
1228311 },
132966 "country": {
142966 "enum": [
154n/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",
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",
762n/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",
1202n/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",
1483n/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",
1572n/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",
1695n/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",
2441n/a "UZ",
2451n/a "VA",
2461n/a "VC",
2471n/a "VE",
2481n/a "VG",
2491n/a "VI",
2501n/a "VN",
2511n/a "VU",
2522n/a "WF",
2531n/a "WS",
2541n/a "YE",
2551n/a "YT",
2561n/a "ZA",
2571n/a "ZM",
2581n/a "ZW"
2592966 ],
2602975 "type": "string",
2612966 },
26228210 "line1": {
26328210 "anyOf": [
2642290 {
2652290 "type": "string"
2662290 },
26728012 {
26828012 "type": "null"
26928012 }
27028210 ],
27128210 },
2722854 "line2": {
2732854 "anyOf": [
2744285 {
2754285 "type": "string"
2764285 },
2772818 {
2782818 "type": "null"
2792818 }
2802854 ],
2812854 },
2822905 "postal_code": {
2832905 "anyOf": [
2849286 {
2859286 "type": "string"
2869286 },
28728114 {
28828114 "type": "null"
28928114 }
2902905 ],
2912905 },
2922824 "state": {
2932824 "anyOf": [
2945281 {
2955281 "type": "string"
2965281 },
2972779 {
2982779 "type": "null"
2992779 }
3002824 ],
3012824 }
30227133 },
3033023 "required": [
3043023 "country"
3053023 ],
30630595 "type": "object"
307269131}
TaxIDFormat3 of 3 keywords
13457{
23457 "enum": [
35n/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",
110n/a "br_cnpj",
120n/a "br_cpf",
13322n/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",
201n/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",
312n/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",
380n/a "il_vat",
391n/a "in_gst",
401n/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",
480n/a "mx_rfc",
490n/a "my_frp",
500n/a "my_itn",
510n/a "my_sst",
521n/a "ng_tin",
535n/a "no_vat",
540n/a "no_voec",
550n/a "nz_gst",
560n/a "om_vat",
574n/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",
730n/a "uy_ruc",
740n/a "ve_rif",
750n/a "vn_tin",
760n/a "za_vat"
773457 ],
783466 "type": "string"
793457}
Responses3 of 3 documented received
codedescriptionhitsavg
200Customer updated.1647ms
404Customer not found.67ms
422Validation Error3916ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error7822ms
401Unauthorized33ms
400Bad Request34ms
Examples8 / 8 used
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 Parameters1 of 1 keywords covered
external_id1 / 1
#validinvalidschema
1305n/a{
2305n/a "type": "string"
3305n/a}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response2696ms
404Customer not found.86ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized283ms
Path Parametersnot covered
idno coverage data
#validinvalidschema
100{
200 "format": "uuid4",
30n/a "type": "string"
400}
Expected Responses0 of 3 documented received
codedescriptionhitsavg
204Customer deleted.0never seen
404Customer not found.0never seen
422Validation Error0never seen
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13141{
23141 "format": "uuid4",
3315n/a "type": "string"
43141}
Query Parameters1 of 1 keywords covered
include_members1 / 1
14624{
24624 "type": "boolean"
34624}
Responses3 of 3 documented received
codedescriptionhitsavg
200Successful Response2485ms
404Customer not found.276ms
422Validation Error255ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized152ms
Examples1 / 1 used
Query
falseinclude_members
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
16810{
26810 "format": "uuid4",
3681n/a "type": "string"
46810}
Query Parameters1 of 1 keywords covered
include_members1 / 1
142513{
242513 "type": "boolean"
342513}
Body55 of 57 keywords covered
application/json55 / 57
CustomerUpdate
158685{
238980 "properties": {
338239 "billing_address": {
438239 "anyOf": [
5298123 {
6298123 "$ref": "#/components/schemas/AddressInput"
7298123 },
884337 {
984337 "type": "null"
1084337 }
1138239 ]
1238239 },
134266 "email": {
144266 "anyOf": [
1540131 {
164302 "format": "email",
1740329 "type": "string"
1840131 },
1925407 {
2025407 "type": "null"
2125407 }
224266 ],
234266 },
244034 "external_id": {
254034 "anyOf": [
2639512 {
2739512 "type": "string"
2839512 },
298399 {
308399 "type": "null"
318399 }
324034 ],
334034 },
343888 "metadata": {
35143 "additionalProperties": {
36476 "anyOf": [
371340 {
38150 "maxLength": 500,
39132 "minLength": 1,
401538 "type": "string"
411340 },
421043 {
431043 "type": "integer"
441043 },
451439 {
461439 "type": "number"
471439 },
482033 {
492033 "type": "boolean"
502033 }
51476 ]
52143 },
533910 "maxProperties": 50,
54152 "propertyNames": {
55521 "maxLength": 40,
56521 "minLength": 1
57152 },
583915 "type": "object"
593888 },
603965 "name": {
613965 "anyOf": [
6238516 {
633851 "maxLength": 256,
6438615 "type": "string"
6538516 },
6611390 {
6711390 "type": "null"
6811390 }
693965 ],
703965 },
7140218 "tax_id": {
7240218 "anyOf": [
7338337 {
743961 "maxItems": 2,
753961 "minItems": 2,
7638512 "prefixItems": [
773916 {
783916 "type": "string"
793916 },
803897 {
813897 "$ref": "#/components/schemas/TaxIDFormat"
823897 }
8338512 ],
8439723 "type": "array"
8538337 },
8619401 {
8719401 "type": "null"
8819401 }
8940218 ],
9040218 }
9138980 },
926665 "type": "object"
9358685}
Referenced Components (2)31 of 31 keywords
AddressInput28 of 28 keywords
1298123{
229933 "properties": {
330211 "city": {
430211 "anyOf": [
513300 {
613300 "type": "string"
713300 },
828924 {
928924 "type": "null"
1028924 }
1130211 ],
1230211 },
133256 "country": {
143256 "enum": [
155n/a "AD",
164n/a "AE",
171n/a "AF",
183n/a "AG",
191n/a "AI",
204n/a "AL",
211n/a "AM",
221n/a "AO",
231n/a "AQ",
241n/a "AR",
255n/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",
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",
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",
1064n/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",
1218n/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",
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",
1752n/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",
1913n/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",
2043n/a "SB",
2051n/a "SC",
2068n/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",
2202n/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",
2571n/a "ZM",
2581n/a "ZW"
2593256 ],
2603265 "type": "string",
2613256 },
2623124 "line1": {
2633124 "anyOf": [
26420296 {
26520296 "type": "string"
26620296 },
26729224 {
26829224 "type": "null"
26929224 }
2703124 ],
2713124 },
2723094 "line2": {
2733094 "anyOf": [
27418295 {
27518295 "type": "string"
27618295 },
27729122 {
27829122 "type": "null"
27929122 }
2803094 ],
2813094 },
2823024 "postal_code": {
2833024 "anyOf": [
2841305 {
2851305 "type": "string"
2861305 },
2873015 {
2883015 "type": "null"
2893015 }
2903024 ],
2913024 },
2923074 "state": {
2933074 "anyOf": [
29416295 {
29516295 "type": "string"
29616295 },
29729120 {
29829120 "type": "null"
29929120 }
3003074 ],
3013074 }
30229933 },
3033312 "required": [
3043312 "country"
3053312 ],
30633388 "type": "object"
307298123}
TaxIDFormat3 of 3 keywords
13897{
23897 "enum": [
35n/a "ad_nrt",
40n/a "ae_trn",
52n/a "ar_cuit",
61n/a "au_abn",
70n/a "au_arn",
80n/a "bg_uic",
90n/a "bh_vat",
100n/a "bo_tin",
110n/a "br_cnpj",
120n/a "br_cpf",
13340n/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",
227n/a "cn_tin",
230n/a "co_nit",
241n/a "cr_tin",
254n/a "de_stn",
260n/a "do_rcn",
271n/a "ec_ruc",
282n/a "eg_tin",
290n/a "es_cif",
300n/a "eu_oss_vat",
316n/a "eu_vat",
320n/a "gb_vat",
330n/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",
412n/a "jp_cn",
422n/a "jp_rn",
430n/a "jp_trn",
440n/a "ke_pin",
450n/a "kr_brn",
460n/a "kz_bin",
470n/a "li_uid",
485n/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",
593n/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",
725n/a "us_ein",
730n/a "uy_ruc",
742n/a "ve_rif",
750n/a "vn_tin",
760n/a "za_vat"
773897 ],
783906 "type": "string"
793897}
Responses3 of 3 documented received
codedescriptionhitsavg
200Customer updated.2178ms
404Customer not found.198ms
422Validation Error4276ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error13954ms
401Unauthorized33ms
400Bad Request26ms
Examples9 / 9 used
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 Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13449{
23449 "format": "uuid4",
3353n/a "type": "string"
43449}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Customer not found.3196ms
422Validation Error94ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized252ms
discounts 5 operations 1 covered 4 partial 0 uncovered 0 not measured 87% #
Query Parameters13 of 20 keywords covered
organization_id2 / 7
#validinvalidschema
17750{
27750 "anyOf": [
30775 {
400 "format": "uuid4",
50n/a "type": "string",
60775 },
77750 {
87750 "items": {
97750 "format": "uuid4",
10775n/a "type": "string",
117750 },
127750 "type": "array"
137750 },
140775 {
150775 "type": "null"
160775 }
177750 ],
187750}
query3 / 3
1188n/a{
2188n/a "anyOf": [
3183n/a {
4183n/a "type": "string"
5183n/a },
65183 {
75183 "type": "null"
85183 }
9188n/a ],
10188n/a}
page2 / 2
131131{
23112 "exclusiveMinimum": 0,
331329 "type": "integer"
431131}
limit2 / 2
135535{
23555 "exclusiveMinimum": 0,
336030 "type": "integer"
435535}
sorting4 / 6
118240{
218240 "anyOf": [
318240 {
418240 "items": {
586656 "$ref": "#/components/schemas/DiscountSortProperty"
618240 },
72220 "type": "array"
818240 },
90222 {
100222 "type": "null"
110222 }
1218240 ],
1318240}
Referenced Components (1)3 of 3 keywords
DiscountSortProperty3 of 3 keywords
186656{
286656 "enum": [
399n/a "created_at",
4135n/a "-created_at",
5111n/a "name",
6112n/a "-name",
795n/a "code",
891n/a "-code",
9115n/a "redemptions_count",
10108n/a "-redemptions_count"
1186656 ],
12896n/a "type": "string"
1386656}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response5767ms
422Validation Error645ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1212ms
500Internal Server Error141463ms
Examples3 / 5 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-created_at" ]sorting
Body177 of 199 keywords covered
application/json177 / 199
DiscountCreate
#validinvalidschema
1235544{
2235544 "oneOf": [
3154625 {
4154625 "$ref": "#/components/schemas/DiscountFixedOnceForeverDurationCreate"
5154625 },
61778 {
71778 "$ref": "#/components/schemas/DiscountFixedRepeatDurationCreate"
81778 },
983696 {
1083696 "$ref": "#/components/schemas/DiscountPercentageOnceForeverDurationCreate"
1183696 },
121778 {
131778 "$ref": "#/components/schemas/DiscountPercentageRepeatDurationCreate"
141778 }
15235544 ]
16235544}
Referenced Components (6)210 of 232 keywords
DiscountDuration3 of 3 keywords
12896168{
22896168 "enum": [
32548n/a "once",
4136n/a "forever",
5212n/a "repeating"
62896168 ],
72936128 "type": "string"
82896168}
DiscountFixedOnceForeverDurationCreate52 of 56 keywords
1154625{
2298476 "properties": {
336724 "amount": {
43733 "maximum": 999999999999.0,
53733 "minimum": 0.0,
637318 "type": "integer"
736724 },
862229 "code": {
962229 "anyOf": [
1047604 {
1147604 "type": "string"
1247604 },
1357576 {
1457576 "type": "null"
1557576 }
1662229 ],
1762229 },
1828021 "currency": {
192806 "pattern": "usd",
2028615 "type": "string"
2128021 },
2272442 "duration": {
2372442 "$ref": "#/components/schemas/DiscountDuration"
2472442 },
2559344 "ends_at": {
2659344 "anyOf": [
2757364 {
2857316 "format": "date-time",
2958948 "type": "string"
3057364 },
3120617 {
3220617 "type": "null"
3320617 }
3459344 ],
3559344 },
3659942 "max_redemptions": {
3759942 "anyOf": [
3858655 {
3958614 "minimum": 1.0,
4059348 "type": "integer"
4158655 },
4213628 {
4313628 "type": "null"
4413628 }
4559942 ],
4659942 },
4758850 "metadata": {
484514 "additionalProperties": {
4912514 "anyOf": [
5037102 {
51510 "maxLength": 500,
523714 "minLength": 1,
535188 "type": "string"
5437102 },
5538101 {
5638101 "type": "integer"
5738101 },
584594 {
594594 "type": "number"
604594 },
614396 {
624396 "type": "boolean"
634396 }
6412514 ]
654514 },
666030 "maxProperties": 50,
674415 "propertyNames": {
681318 "maxLength": 40,
691327 "minLength": 1
704415 },
7160335 "type": "object"
7258850 },
7372244 "name": {
747227 "minLength": 1,
7572937 "type": "string"
7672244 },
7772428 "organization_id": {
7872428 "anyOf": [
7972230 {
807220 "format": "uuid4",
8172230 "type": "string",
8272230 },
832750 {
842750 "type": "null"
852750 }
8672428 ],
8772428 },
8856475 "products": {
8956475 "anyOf": [
90523116 {
9152346 "items": {
92950 "format": "uuid4",
939589 "type": "string"
9452346 },
9556970 "type": "array"
96523116 },
9741598 {
9841598 "type": "null"
9941598 }
10056475 ],
10156475 },
10257843 "starts_at": {
10357843 "anyOf": [
10455962 {
10555915 "format": "date-time",
10657447 "type": "string"
10755962 },
10819602 {
10919602 "type": "null"
11019602 }
11157843 ],
11257843 },
11372145 "type": {
11472145 "$ref": "#/components/schemas/DiscountType",
11572145 }
116298476 },
117382392 "required": [
1187668 "duration",
1197668 "type",
120391383 "amount",
1217668 "name"
122382392 ],
1237745 "type": "object"
124154625}
DiscountFixedRepeatDurationCreate52 of 59 keywords
11778{
2298476 "properties": {
336724 "amount": {
43733 "maximum": 999999999999.0,
53733 "minimum": 0.0,
637318 "type": "integer"
736724 },
862229 "code": {
962229 "anyOf": [
1047604 {
1147604 "type": "string"
1247604 },
1357576 {
1457576 "type": "null"
1557576 }
1662229 ],
1762229 },
1828021 "currency": {
192806 "pattern": "usd",
2028615 "type": "string"
2128021 },
2272442 "duration": {
2372442 "$ref": "#/components/schemas/DiscountDuration"
2472442 },
253080 "duration_in_months": {
263080 "maximum": 999.0,
273080 "minimum": 1.0,
283080 "type": "integer"
293080 },
3059344 "ends_at": {
3159344 "anyOf": [
3257364 {
3357316 "format": "date-time",
3458948 "type": "string"
3557364 },
3620617 {
3720617 "type": "null"
3820617 }
3959344 ],
4059344 },
4159942 "max_redemptions": {
4259942 "anyOf": [
4358655 {
4458614 "minimum": 1.0,
4559348 "type": "integer"
4658655 },
4713628 {
4813628 "type": "null"
4913628 }
5059942 ],
5159942 },
5258850 "metadata": {
534514 "additionalProperties": {
5412514 "anyOf": [
5537102 {
56510 "maxLength": 500,
573714 "minLength": 1,
585188 "type": "string"
5937102 },
6038101 {
6138101 "type": "integer"
6238101 },
634594 {
644594 "type": "number"
654594 },
664396 {
674396 "type": "boolean"
684396 }
6912514 ]
704514 },
716030 "maxProperties": 50,
724415 "propertyNames": {
731318 "maxLength": 40,
741327 "minLength": 1
754415 },
7660335 "type": "object"
7758850 },
7872244 "name": {
797227 "minLength": 1,
8072937 "type": "string"
8172244 },
8272428 "organization_id": {
8372428 "anyOf": [
8472230 {
857220 "format": "uuid4",
8672230 "type": "string",
8772230 },
882750 {
892750 "type": "null"
902750 }
9172428 ],
9272428 },
9356475 "products": {
9456475 "anyOf": [
95523116 {
9652346 "items": {
97950 "format": "uuid4",
989589 "type": "string"
9952346 },
10056970 "type": "array"
101523116 },
10241598 {
10341598 "type": "null"
10441598 }
10556475 ],
10656475 },
10757843 "starts_at": {
10857843 "anyOf": [
10955962 {
11055915 "format": "date-time",
11157447 "type": "string"
11255962 },
11319602 {
11419602 "type": "null"
11519602 }
11657843 ],
11757843 },
11872145 "type": {
11972145 "$ref": "#/components/schemas/DiscountType",
12072145 }
121298476 },
122151623 "required": [
1237668 "duration",
124308466 "duration_in_months",
1257668 "type",
126391383 "amount",
1277668 "name"
128151623 ],
1297745 "type": "object"
1301778}
DiscountPercentageOnceForeverDurationCreate50 of 54 keywords
183696{
2308466 "properties": {
334332 "basis_points": {
43514 "maximum": 10000.0,
53478 "minimum": 1.0,
635124 "type": "integer"
734332 },
862229 "code": {
962229 "anyOf": [
1047604 {
1147604 "type": "string"
1247604 },
1357576 {
1457576 "type": "null"
1557576 }
1662229 ],
1762229 },
1872442 "duration": {
1972442 "$ref": "#/components/schemas/DiscountDuration"
2072442 },
2159344 "ends_at": {
2259344 "anyOf": [
2357364 {
2457316 "format": "date-time",
2558948 "type": "string"
2657364 },
2720617 {
2820617 "type": "null"
2920617 }
3059344 ],
3159344 },
3259942 "max_redemptions": {
3359942 "anyOf": [
3458655 {
3558614 "minimum": 1.0,
3659348 "type": "integer"
3758655 },
3813628 {
3913628 "type": "null"
4013628 }
4159942 ],
4259942 },
4358850 "metadata": {
444514 "additionalProperties": {
4512514 "anyOf": [
4637102 {
47510 "maxLength": 500,
483714 "minLength": 1,
495188 "type": "string"
5037102 },
5138101 {
5238101 "type": "integer"
5338101 },
544594 {
554594 "type": "number"
564594 },
574396 {
584396 "type": "boolean"
594396 }
6012514 ]
614514 },
626030 "maxProperties": 50,
634415 "propertyNames": {
641318 "maxLength": 40,
651327 "minLength": 1
664415 },
6760335 "type": "object"
6858850 },
6972244 "name": {
707227 "minLength": 1,
7172937 "type": "string"
7272244 },
7372428 "organization_id": {
7472428 "anyOf": [
7572230 {
767220 "format": "uuid4",
7772230 "type": "string",
7872230 },
792750 {
802750 "type": "null"
812750 }
8272428 ],
8372428 },
8456475 "products": {
8556475 "anyOf": [
86523116 {
8752346 "items": {
88950 "format": "uuid4",
899589 "type": "string"
9052346 },
9156970 "type": "array"
92523116 },
9341598 {
9441598 "type": "null"
9541598 }
9656475 ],
9756475 },
9857843 "starts_at": {
9957843 "anyOf": [
10055962 {
10155915 "format": "date-time",
10257447 "type": "string"
10355962 },
10419602 {
10519602 "type": "null"
10619602 }
10757843 ],
10857843 },
10972145 "type": {
11072145 "$ref": "#/components/schemas/DiscountType",
11172145 }
112308466 },
113363411 "required": [
1147668 "duration",
1157668 "type",
116375399 "basis_points",
1177668 "name"
118363411 ],
1197745 "type": "object"
12083696}
DiscountPercentageRepeatDurationCreate50 of 57 keywords
11778{
2308466 "properties": {
334332 "basis_points": {
43514 "maximum": 10000.0,
53478 "minimum": 1.0,
635124 "type": "integer"
734332 },
862229 "code": {
962229 "anyOf": [
1047604 {
1147604 "type": "string"
1247604 },
1357576 {
1457576 "type": "null"
1557576 }
1662229 ],
1762229 },
1872442 "duration": {
1972442 "$ref": "#/components/schemas/DiscountDuration"
2072442 },
213080 "duration_in_months": {
223080 "maximum": 999.0,
233080 "minimum": 1.0,
243080 "type": "integer"
253080 },
2659344 "ends_at": {
2759344 "anyOf": [
2857364 {
2957316 "format": "date-time",
3058948 "type": "string"
3157364 },
3220617 {
3320617 "type": "null"
3420617 }
3559344 ],
3659344 },
3759942 "max_redemptions": {
3859942 "anyOf": [
3958655 {
4058614 "minimum": 1.0,
4159348 "type": "integer"
4258655 },
4313628 {
4413628 "type": "null"
4513628 }
4659942 ],
4759942 },
4858850 "metadata": {
494514 "additionalProperties": {
5012514 "anyOf": [
5137102 {
52510 "maxLength": 500,
533714 "minLength": 1,
545188 "type": "string"
5537102 },
5638101 {
5738101 "type": "integer"
5838101 },
594594 {
604594 "type": "number"
614594 },
624396 {
634396 "type": "boolean"
644396 }
6512514 ]
664514 },
676030 "maxProperties": 50,
684415 "propertyNames": {
691318 "maxLength": 40,
701327 "minLength": 1
714415 },
7260335 "type": "object"
7358850 },
7472244 "name": {
757227 "minLength": 1,
7672937 "type": "string"
7772244 },
7872428 "organization_id": {
7972428 "anyOf": [
8072230 {
817220 "format": "uuid4",
8272230 "type": "string",
8372230 },
842750 {
852750 "type": "null"
862750 }
8772428 ],
8872428 },
8956475 "products": {
9056475 "anyOf": [
91523116 {
9252346 "items": {
93950 "format": "uuid4",
949589 "type": "string"
9552346 },
9656970 "type": "array"
97523116 },
9841598 {
9941598 "type": "null"
10041598 }
10156475 ],
10256475 },
10357843 "starts_at": {
10457843 "anyOf": [
10555962 {
10655915 "format": "date-time",
10757447 "type": "string"
10855962 },
10919602 {
11019602 "type": "null"
11119602 }
11257843 ],
11357843 },
11472145 "type": {
11572145 "$ref": "#/components/schemas/DiscountType",
11672145 }
117308466 },
118141633 "required": [
1197668 "duration",
120308466 "duration_in_months",
1217668 "type",
122375399 "basis_points",
1237668 "name"
124141633 ],
1257745 "type": "object"
1261778}
DiscountType3 of 3 keywords
12884180{
22884180 "enum": [
32556n/a "fixed",
4328n/a "percentage"
52884180 ],
62924140 "type": "string"
72884180}
Responses1 of 2 documented received
codedescriptionhitsavg
201Discount created.0never seen
422Validation Error7086ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error85971ms
400Bad Request55ms
Examples6 / 6 used
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 Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13020{
23020 "format": "uuid4",
3302n/a "type": "string"
43020}
Responses1 of 3 documented received
codedescriptionhitsavg
204Discount deleted.0never seen
404Discount not found.2796ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized232ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
129012{
229012 "format": "uuid4",
3302n/a "type": "string"
429012}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Discount not found.2615ms
422Validation Error125ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized292ms
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
14420{
24420 "format": "uuid4",
3442n/a "type": "string"
44420}
Body63 of 66 keywords covered
application/json63 / 66
DiscountUpdate
116699{
213494 "properties": {
31529 "amount": {
41529 "anyOf": [
513328 {
61371 "maximum": 999999999999.0,
71371 "minimum": 0.0,
813526 "type": "integer"
913328 },
1019142 {
1119142 "type": "null"
1219142 }
131529 ],
141529 },
1516012 "basis_points": {
1616012 "anyOf": [
1713339 {
181352 "maximum": 10000.0,
191352 "minimum": 1.0,
2013636 "type": "integer"
2113339 },
2227145 {
2327145 "type": "null"
2427145 }
2516012 ],
2616012 },
271694 "code": {
281694 "anyOf": [
2928145 {
3028145 "type": "string"
3128145 },
3214132 {
3314132 "type": "null"
3414132 }
351694 ],
361694 },
371506 "currency": {
381506 "anyOf": [
3914610 {
401462 "pattern": "usd",
411488 "type": "string"
4214610 },
434152 {
444152 "type": "null"
454152 }
461506 ],
471506 },
4816410 "duration": {
4916410 "anyOf": [
5019155 {
5119155 "$ref": "#/components/schemas/DiscountDuration"
5219155 },
5314529 {
5414529 "type": "null"
5514529 }
5616410 ]
5716410 },
581567 "duration_in_months": {
591567 "anyOf": [
6014221 {
611441 "maximum": 999.0,
621432 "minimum": 1.0,
6314419 "type": "integer"
6414221 },
6514149 {
6614149 "type": "null"
6714149 }
681567 ],
691567 },
701526 "ends_at": {
711526 "anyOf": [
7214216 {
731422 "format": "date-time",
7414414 "type": "string"
7514216 },
7610148 {
7710148 "type": "null"
7810148 }
791526 ],
801526 },
811526 "max_redemptions": {
821526 "anyOf": [
8313424 {
841342 "minimum": 1.0,
8513523 "type": "integer"
8613424 },
8718140 {
8818140 "type": "null"
8918140 }
901526 ],
911526 },
921428 "metadata": {
93212 "additionalProperties": {
94362 "anyOf": [
95632 {
9680 "maxLength": 500,
9762 "minLength": 1,
98830 "type": "string"
99632 },
100632 {
101632 "type": "integer"
102632 },
1031127 {
1041127 "type": "number"
1051127 },
1061919 {
1071919 "type": "boolean"
1081919 }
109362 ]
110212 },
1111450 "maxProperties": 50,
112203 "propertyNames": {
113362 "maxLength": 40,
114371 "minLength": 1
115203 },
1161455 "type": "object"
1171428 },
1181406 "name": {
1191406 "anyOf": [
12013610 {
1211361 "minLength": 1,
1221379 "type": "string"
12313610 },
1244142 {
1254142 "type": "null"
1264142 }
1271406 ],
1281406 },
12915610 "products": {
13015610 "anyOf": [
13113729 {
1321376 "items": {
1331340 "format": "uuid4",
1341347 "type": "string"
1351376 },
13614323 "type": "array"
13713729 },
13819147 {
13919147 "type": "null"
14019147 }
14115610 ],
14215610 },
14315114 "starts_at": {
14415114 "anyOf": [
14514025 {
1461407 "format": "date-time",
14714718 "type": "string"
14814025 },
14911154 {
15011154 "type": "null"
15111154 }
15215114 ],
15315114 },
1541425 "type": {
1551425 "anyOf": [
15616131 {
15716131 "$ref": "#/components/schemas/DiscountType"
15816131 },
15912621 {
16012621 "type": "null"
16112621 }
1621425 ]
1631425 }
16413494 },
1652605 "type": "object"
16616699}
Referenced Components (2)6 of 6 keywords
DiscountDuration3 of 3 keywords
119155{
219155 "enum": [
31n/a "once",
41n/a "forever",
517n/a "repeating"
619155 ],
724150 "type": "string"
819155}
DiscountType3 of 3 keywords
116131{
216131 "enum": [
39n/a "fixed",
47n/a "percentage"
516131 ],
617130 "type": "string"
716131}
Responses2 of 3 documented received
codedescriptionhitsavg
200Discount updated.0never seen
404Discount not found.1107ms
422Validation Error2295ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request945ms
401Unauthorized93ms
email-update 2 operations 1 covered 1 partial 0 uncovered 0 not measured 66% #
Body8 of 8 keywords covered
application/json8 / 8
EmailUpdateRequest
#validinvalidschema
112332{
212622 "properties": {
312718 "email": {
413213 "format": "email",
51405 "type": "string"
612718 },
7754 "return_to": {
8754 "anyOf": [
92257 {
102257 "type": "string"
112257 },
125326 {
135326 "type": "null"
145326 }
15754 ],
16754 }
1712622 },
181453 "required": [
191453 "email"
201453 ],
211487 "type": "object"
2212332}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response1843ms
422Validation Error2068ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized92ms
400Bad Request576ms
Query Parameters2 of 3 keywords covered
return_to2 / 3
#validinvalidschema
115n/a{
215n/a "anyOf": [
315n/a {
415n/a "type": "string"
515n/a },
6015 {
7015 "type": "null"
8015 }
915n/a ],
1015n/a}
Body0 of 4 keywords covered
application/x-www-form-urlencoded0 / 4
Body_email-update_verify_email_update
100{
20n/a "properties": {
30n/a "token": {
40n/a "type": "string"
50n/a }
60n/a },
700 "required": [
800 "token"
900 ],
100n/a "type": "object"
1100}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error35ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request14ms
event-types 2 operations 0 covered 2 partial 0 uncovered 0 not measured 70% #
Query Parameters30 of 42 keywords covered
organization_id2 / 7
#validinvalidschema
16490{
26490 "anyOf": [
30649 {
400 "format": "uuid4",
50n/a "type": "string",
60649 },
76490 {
86490 "items": {
96490 "format": "uuid4",
10649n/a "type": "string",
116490 },
126490 "type": "array"
136490 },
140649 {
150649 "type": "null"
160649 }
176490 ],
186490}
customer_id4 / 7
126812{
226812 "anyOf": [
30280 {
400 "format": "uuid4",
50n/a "type": "string"
60280 },
726812 {
826812 "items": {
942115 "format": "uuid4",
10436n/a "type": "string"
1126812 },
122800 "type": "array"
1326812 },
140280 {
150280 "type": "null"
160280 }
1726812 ],
1826812}
external_customer_id3 / 5
1120n/a{
2120n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
612078 {
7120n/a "items": {
8376n/a "type": "string"
9120n/a },
101980 "type": "array"
1112078 },
120198 {
130198 "type": "null"
140198 }
15120n/a ],
16120n/a}
query3 / 3
1185n/a{
2185n/a "anyOf": [
3178n/a {
4178n/a "type": "string"
5178n/a },
67178 {
77178 "type": "null"
87178 }
9185n/a ],
10185n/a}
root_events1 / 1
125010{
225010 "type": "boolean"
325010}
parent_id4 / 4
119319{
219319 "anyOf": [
318626 {
418619 "format": "uuid",
5205n/a "type": "string"
618626 },
77205 {
87205 "type": "null"
97205 }
1019319 ],
1119319}
source5 / 5
117113{
217113 "anyOf": [
316618 {
416618 "$ref": "#/components/schemas/EventSource"
516618 },
65179 {
75179 "type": "null"
85179 }
917113 ],
1017113}
Referenced Components (1)3 of 3 keywords
EventSource3 of 3 keywords
116618{
216618 "enum": [
3122n/a "system",
444n/a "user"
516618 ],
6179n/a "type": "string"
716618}
page2 / 2
127120{
22714 "exclusiveMinimum": 0,
327516 "type": "integer"
427120}
limit2 / 2
127215{
22722 "exclusiveMinimum": 0,
327413 "type": "integer"
427215}
sorting4 / 6
114722{
214722 "anyOf": [
314722 {
414722 "items": {
563124 "$ref": "#/components/schemas/EventTypesSortProperty"
614722 },
71690 "type": "array"
814722 },
90169 {
100169 "type": "null"
110169 }
1214722 ],
1314722}
Referenced Components (1)3 of 3 keywords
EventTypesSortProperty3 of 3 keywords
163124{
263124 "enum": [
358n/a "name",
454n/a "-name",
532n/a "label",
678n/a "-label",
772n/a "occurrences",
842n/a "-occurrences",
939n/a "first_seen",
1070n/a "-first_seen",
1143n/a "last_seen",
12143n/a "-last_seen"
1363124 ],
14637n/a "type": "string"
1563124}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response4247ms
422Validation Error955ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1212ms
500Internal Server Error91480ms
Examples4 / 6 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
falseroot_events
1page
10limit
[ "-last_seen" ]sorting
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13310{
23310 "format": "uuid4",
3331n/a "type": "string"
43310}
Body11 of 11 keywords covered
application/json11 / 11
EventTypeUpdate
127631{
227724 "properties": {
328218 "label": {
42882 "maxLength": 128,
52846 "minLength": 1,
629010 "type": "string"
728218 },
84412 "label_property_selector": {
94412 "anyOf": [
102927 {
11301 "maxLength": 256,
12301 "minLength": 1,
133125 "type": "string"
142927 },
151541 {
161541 "type": "null"
171541 }
184412 ],
194412 }
2027724 },
213002 "required": [
223002 "label"
233002 ],
243025 "type": "object"
2527631}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Not Found2766ms
422Validation Error525ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request35ms
events 5 operations 0 covered 5 partial 0 uncovered 0 not measured 68% #
Query Parameters50 of 77 keywords covered
filter3 / 3
#validinvalidschema
1143n/a{
2143n/a "anyOf": [
3141n/a {
4141n/a "type": "string"
5141n/a },
62141 {
72141 "type": "null"
82141 }
9143n/a ],
10143n/a}
start_timestamp4 / 4
115618{
215618 "anyOf": [
315024 {
415018 "format": "date-time",
5168n/a "type": "string"
615024 },
76168 {
86168 "type": "null"
96168 }
1015618 ],
1115618}
end_timestamp4 / 4
116819{
216819 "anyOf": [
316324 {
416319 "format": "date-time",
5182n/a "type": "string"
616324 },
75182 {
85182 "type": "null"
95182 }
1016819 ],
1116819}
organization_id2 / 7
16590{
26590 "anyOf": [
30659 {
400 "format": "uuid4",
50n/a "type": "string",
60659 },
76590 {
86590 "items": {
96590 "format": "uuid4",
10659n/a "type": "string",
116590 },
126590 "type": "array"
136590 },
140659 {
150659 "type": "null"
160659 }
176590 ],
186590}
customer_id3 / 7
11908{
21908 "anyOf": [
30198 {
400 "format": "uuid4",
50n/a "type": "string"
60198 },
71908 {
81908 "items": {
92790 "format": "uuid4",
10279n/a "type": "string"
111908 },
121980 "type": "array"
131908 },
140198 {
150198 "type": "null"
160198 }
171908 ],
181908}
external_customer_id3 / 5
153n/a{
253n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
653114 {
753n/a "items": {
8170n/a "type": "string"
953n/a },
101670 "type": "array"
1153114 },
120167 {
130167 "type": "null"
140167 }
1553n/a ],
1653n/a}
meter_id4 / 4
11438{
21438 "anyOf": [
314011 {
41408 "format": "uuid4",
5148n/a "type": "string"
614011 },
73148 {
83148 "type": "null"
93148 }
101438 ],
111438}
name3 / 5
157n/a{
257n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
657105 {
757n/a "items": {
865n/a "type": "string"
957n/a },
101620 "type": "array"
1157105 },
120162 {
130162 "type": "null"
140162 }
1557n/a ],
1657n/a}
source4 / 7
113516{
213516 "anyOf": [
30151 {
40151 "$ref": "#/components/schemas/EventSource"
50151 },
613516 {
713516 "items": {
818128 "$ref": "#/components/schemas/EventSource"
913516 },
101510 "type": "array"
1113516 },
120151 {
130151 "type": "null"
140151 }
1513516 ],
1613516}
Referenced Components (1)3 of 3 keywords
EventSource3 of 3 keywords
1181179{
2181179 "enum": [
3135n/a "system",
446n/a "user"
5181179 ],
6196n/a "type": "string"
7181179}
query3 / 3
1157n/a{
2157n/a "anyOf": [
3154n/a {
4154n/a "type": "string"
5154n/a },
63154 {
73154 "type": "null"
83154 }
9157n/a ],
10157n/a}
parent_id4 / 4
11467{
21467 "anyOf": [
314310 {
41437 "format": "uuid4",
5150n/a "type": "string"
614310 },
73150 {
83150 "type": "null"
93150 }
101467 ],
111467}
hierarchical1 / 1
119410{
219410 "type": "boolean"
319410}
page2 / 2
117213{
21722 "exclusiveMinimum": 0,
317411 "type": "integer"
417213}
limit2 / 2
117817{
21786 "exclusiveMinimum": 0,
318411 "type": "integer"
417817}
sorting4 / 6
113316{
213316 "anyOf": [
313316 {
413316 "items": {
531419 "$ref": "#/components/schemas/EventSortProperty"
613316 },
71490 "type": "array"
813316 },
90149 {
100149 "type": "null"
110149 }
1213316 ],
1313316}
Referenced Components (1)3 of 3 keywords
EventSortProperty3 of 3 keywords
131419{
231419 "enum": [
3104n/a "timestamp",
4210n/a "-timestamp"
531419 ],
6321n/a "type": "string"
731419}
metadata4 / 13
MetadataQuery
1300{
2300 "anyOf": [
3300 {
4300 "additionalProperties": {
5740 "anyOf": [
64232 {
74232 "type": "string"
84232 },
9074 {
10074 "type": "integer"
11074 },
12074 {
13074 "type": "boolean"
14074 },
153242 {
16320 "items": {
171920 "type": "string"
18320 },
193242 "type": "array"
203242 },
21074 {
22032 "items": {
230192 "type": "integer"
24032 },
253242 "type": "array"
26074 },
27074 {
28032 "items": {
290192 "type": "boolean"
30032 },
313242 "type": "array"
32074 }
33740 ]
34300 },
35300 "type": "object"
36300 },
37030 {
38030 "type": "null"
39030 }
40300 ],
41300}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response38710ms
422Validation Error2357ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized342ms
500Internal Server Error31485ms
Examples4 / 6 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
falsehierarchical
1page
10limit
[ "-timestamp" ]sorting
Body76 of 79 keywords covered
application/json76 / 79
EventsIngest
#validinvalidschema
1424723{
2424700 "properties": {
3424700 "events": {
4424685 "items": {
51118696 "anyOf": [
66011213 {
76011213 "$ref": "#/components/schemas/EventCreateCustomer"
86011213 },
95171297 {
105171297 "$ref": "#/components/schemas/EventCreateExternalCustomer"
115171297 }
121118696 ]
13424685 },
14110915 "type": "array"
15424700 }
16424700 },
1711248 "required": [
1811248 "events"
1911248 ],
20113215 "type": "object"
21424723}
Referenced Components (5)88 of 91 keywords
CostMetadata-Input12 of 12 keywords
11762250{
21786166 "properties": {
3184694 "amount": {
4184694 "anyOf": [
51658282 {
61658282 "type": "number"
71658282 },
81881752 {
918812 "pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,5}|(?=[\\d.]{1,18}0*$)\\d{0,5}\\.\\d{0,12}0*$)",
102001740 "type": "string"
111881752 }
12184694 ],
13184694 },
14186872 "currency": {
15186812 "pattern": "usd",
16188060 "type": "string"
17186872 }
181786166 },
19192824 "required": [
20194012 "amount",
21194012 "currency"
22192824 ],
23195260 "type": "object"
241762250}
EventCreateCustomer22 of 24 keywords
16011213{
21142657 "properties": {
392015 "customer_id": {
49200 "format": "uuid4",
592015 "type": "string"
692015 },
7122648 "external_id": {
8122648 "anyOf": [
92241050 {
102241050 "type": "string"
112241050 },
121002272 {
131002272 "type": "null"
141002272 }
15122648 ],
16122648 },
17763504 "metadata": {
18763504 "$ref": "#/components/schemas/EventMetadataInput",
19763504 },
20176330 "name": {
21176330 "type": "string"
22176330 },
23119941 "organization_id": {
24119941 "anyOf": [
25997243 {
269970 "format": "uuid4",
27997243 "type": "string",
28997243 },
292021038 {
302021038 "type": "null"
312021038 }
32119941 ],
33119941 },
34118624 "parent_id": {
35118624 "anyOf": [
362031007 {
372031007 "type": "string"
382031007 },
39983227 {
40983227 "type": "null"
41983227 }
42118624 ],
43118624 },
44123736 "timestamp": {
4512376 "format": "date-time",
46124330 "type": "string"
47123736 }
481142657 },
49932867 "required": [
5017936 "name",
51935864 "customer_id"
52932867 ],
53179915 "type": "object"
546011213}
EventCreateExternalCustomer22 of 23 keywords
15171297{
21142657 "properties": {
384615 "external_customer_id": {
484615 "type": "string"
584615 },
6122648 "external_id": {
7122648 "anyOf": [
82241050 {
92241050 "type": "string"
102241050 },
111002272 {
121002272 "type": "null"
131002272 }
14122648 ],
15122648 },
16763504 "metadata": {
17763504 "$ref": "#/components/schemas/EventMetadataInput",
18763504 },
19176330 "name": {
20176330 "type": "string"
21176330 },
22119941 "organization_id": {
23119941 "anyOf": [
24997243 {
259970 "format": "uuid4",
26997243 "type": "string",
27997243 },
282021038 {
292021038 "type": "null"
302021038 }
31119941 ],
32119941 },
33118624 "parent_id": {
34118624 "anyOf": [
352031007 {
362031007 "type": "string"
372031007 },
38983227 {
39983227 "type": "null"
40983227 }
41118624 ],
42118624 },
43123736 "timestamp": {
4412376 "format": "date-time",
45124330 "type": "string"
46123736 }
471142657 },
48858941 "required": [
4917936 "name",
50861938 "external_customer_id"
51858941 ],
52179915 "type": "object"
535171297}
EventMetadataInput13 of 13 keywords
115261008{
273260 "additionalProperties": {
3210260 "anyOf": [
46481514 {
566012 "maxLength": 500,
666012 "minLength": 1,
76721490 "type": "string"
86481514 },
95461616 {
105461616 "type": "integer"
115461616 },
127501412 {
137501412 "type": "number"
147501412 },
157041458 {
167041458 "type": "boolean"
177041458 }
18210260 ]
1973260 },
201234888 "properties": {
211762250 "_cost": {
221762250 "$ref": "#/components/schemas/CostMetadata-Input"
231762250 },
241350638 "_llm": {
251350638 "$ref": "#/components/schemas/LLMMetadata"
261350638 }
271234888 },
28247460 "type": "object"
2915261008}
LLMMetadata19 of 19 keywords
11350638{
21410518 "properties": {
3159886 "cached_input_tokens": {
4159886 "type": "integer"
5159886 },
6184472 "input_tokens": {
7184472 "type": "integer"
8184472 },
9184274 "model": {
10184274 "type": "string"
11184274 },
12184472 "output_tokens": {
13184472 "type": "integer"
14184472 },
15160048 "prompt": {
16160048 "anyOf": [
171001548 {
181001548 "type": "string"
191001548 },
201500148 {
211500148 "type": "null"
221500148 }
23160048 ],
24160048 },
25161248 "response": {
26161248 "anyOf": [
27981562 {
28981562 "type": "string"
29981562 },
301514146 {
311514146 "type": "null"
321514146 }
33161248 ],
34161248 },
35184472 "total_tokens": {
36184472 "type": "integer"
37184472 },
38185660 "vendor": {
39185660 "type": "string"
40185660 }
411410518 },
42186860 "required": [
43191612 "vendor",
44191612 "model",
45191612 "input_tokens",
46191612 "output_tokens",
47191612 "total_tokens"
48186860 ],
49192860 "type": "object"
501350638}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response617ms
422Validation Error10476ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized633ms
400Bad Request45ms
Examples2 / 2 used
Body: application/json
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"EventCreateCustomer.organization_id.examples[0]
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"EventCreateExternalCustomer.organization_id.examples[0]
Query Parameters23 of 39 keywords covered
organization_id2 / 7
#validinvalidschema
14770{
24770 "anyOf": [
30477 {
400 "format": "uuid4",
50n/a "type": "string",
60477 },
74770 {
84770 "items": {
94770 "format": "uuid4",
10477n/a "type": "string",
114770 },
124770 "type": "array"
134770 },
140477 {
150477 "type": "null"
160477 }
174770 ],
184770}
customer_id3 / 7
11635{
21635 "anyOf": [
30168 {
400 "format": "uuid4",
50n/a "type": "string"
60168 },
71635 {
81635 "items": {
92970 "format": "uuid4",
10297n/a "type": "string"
111635 },
121680 "type": "array"
131635 },
140168 {
150168 "type": "null"
160168 }
171635 ],
181635}
external_customer_id3 / 5
1108n/a{
2108n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
610864 {
7108n/a "items": {
8352n/a "type": "string"
9108n/a },
101720 "type": "array"
1110864 },
120172 {
130172 "type": "null"
140172 }
15108n/a ],
16108n/a}
source4 / 7
111620{
211620 "anyOf": [
30136 {
40136 "$ref": "#/components/schemas/EventSource"
50136 },
611620 {
711620 "items": {
833650 "$ref": "#/components/schemas/EventSource"
911620 },
101360 "type": "array"
1111620 },
120136 {
130136 "type": "null"
140136 }
1511620 ],
1611620}
Referenced Components (1)3 of 3 keywords
EventSource3 of 3 keywords
1336186{
2336186 "enum": [
3191n/a "system",
4145n/a "user"
5336186 ],
6367n/a "type": "string"
7336186}
query3 / 3
1138n/a{
2138n/a "anyOf": [
3132n/a {
4132n/a "type": "string"
5132n/a },
66132 {
76132 "type": "null"
86132 }
9138n/a ],
10138n/a}
page2 / 2
120224{
22022 "exclusiveMinimum": 0,
320422 "type": "integer"
420224}
limit2 / 2
122116{
22212 "exclusiveMinimum": 0,
322314 "type": "integer"
422116}
sorting4 / 6
111116{
211116 "anyOf": [
311116 {
411116 "items": {
533918 "$ref": "#/components/schemas/EventNamesSortProperty"
611116 },
71270 "type": "array"
811116 },
90127 {
100127 "type": "null"
110127 }
1211116 ],
1311116}
Referenced Components (1)3 of 3 keywords
EventNamesSortProperty3 of 3 keywords
133918{
233918 "enum": [
347n/a "name",
452n/a "-name",
548n/a "occurrences",
624n/a "-occurrences",
732n/a "first_seen",
839n/a "-first_seen",
930n/a "last_seen",
1067n/a "-last_seen"
1133918 ],
12341n/a "type": "string"
1333918}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response3367ms
422Validation Error605ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized672ms
500Internal Server Error141497ms
Examples3 / 5 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-last_seen" ]sorting
Query Parameters48 of 75 keywords covered
start_date2 / 2
#validinvalidschema
1123984{
2123984 "format": "date",
31323n/a "type": "string"
4123984}
end_date2 / 2
1124084{
2124084 "format": "date",
31324n/a "type": "string"
4124084}
timezone3 / 3
169914{
269914 "enum": [
3105n/a "Africa/Abidjan",
41n/a "Africa/Accra",
51n/a "Africa/Addis_Ababa",
61n/a "Africa/Algiers",
72n/a "Africa/Asmara",
81n/a "Africa/Bamako",
91n/a "Africa/Bangui",
101n/a "Africa/Banjul",
111n/a "Africa/Bissau",
121n/a "Africa/Blantyre",
131n/a "Africa/Brazzaville",
141n/a "Africa/Bujumbura",
152n/a "Africa/Cairo",
161n/a "Africa/Casablanca",
171n/a "Africa/Ceuta",
181n/a "Africa/Conakry",
192n/a "Africa/Dakar",
201n/a "Africa/Dar_es_Salaam",
211n/a "Africa/Djibouti",
221n/a "Africa/Douala",
231n/a "Africa/El_Aaiun",
241n/a "Africa/Freetown",
253n/a "Africa/Gaborone",
261n/a "Africa/Harare",
271n/a "Africa/Johannesburg",
282n/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",
352n/a "Africa/Lome",
361n/a "Africa/Luanda",
371n/a "Africa/Lubumbashi",
381n/a "Africa/Lusaka",
391n/a "Africa/Malabo",
401n/a "Africa/Maputo",
411n/a "Africa/Maseru",
423n/a "Africa/Mbabane",
431n/a "Africa/Mogadishu",
442n/a "Africa/Monrovia",
451n/a "Africa/Nairobi",
461n/a "Africa/Ndjamena",
471n/a "Africa/Niamey",
481n/a "Africa/Nouakchott",
491n/a "Africa/Ouagadougou",
501n/a "Africa/Porto-Novo",
511n/a "Africa/Sao_Tome",
521n/a "Africa/Timbuktu",
531n/a "Africa/Tripoli",
541n/a "Africa/Tunis",
551n/a "Africa/Windhoek",
561n/a "America/Adak",
571n/a "America/Anchorage",
581n/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",
931n/a "America/Chihuahua",
941n/a "America/Ciudad_Juarez",
951n/a "America/Coral_Harbour",
962n/a "America/Costa_Rica",
971n/a "America/Coyhaique",
983n/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",
1112n/a "America/Fort_Nelson",
1123n/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",
1282n/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",
1342n/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",
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",
1461n/a "America/Marigot",
1471n/a "America/Martinique",
1481n/a "America/Matamoros",
1491n/a "America/Mazatlan",
1501n/a "America/Menominee",
1516n/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",
1601n/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",
1702n/a "America/Panama",
1711n/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",
1782n/a "America/Puerto_Rico",
1793n/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",
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",
2002n/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",
2082n/a "America/Virgin",
2091n/a "America/Whitehorse",
2102n/a "America/Winnipeg",
2111n/a "America/Yakutat",
2121n/a "America/Yellowknife",
2136n/a "Antarctica/Casey",
2141n/a "Antarctica/Davis",
2151n/a "Antarctica/DumontDUrville",
2161n/a "Antarctica/Macquarie",
2171n/a "Antarctica/Mawson",
2181n/a "Antarctica/McMurdo",
2191n/a "Antarctica/Palmer",
2201n/a "Antarctica/Rothera",
2211n/a "Antarctica/Syowa",
2222n/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",
2294n/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",
2402n/a "Asia/Brunei",
2411n/a "Asia/Chita",
2421n/a "Asia/Chongqing",
2432n/a "Asia/Colombo",
2441n/a "Asia/Damascus",
2451n/a "Asia/Dhaka",
2461n/a "Asia/Dili",
2471n/a "Asia/Dubai",
2481n/a "Asia/Dushanbe",
2493n/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",
2621n/a "Asia/Kamchatka",
2631n/a "Asia/Karachi",
2641n/a "Asia/Kashgar",
2652n/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",
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",
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",
3082n/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",
3172n/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",
3347n/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",
3431n/a "Etc/GMT+2",
3442n/a "Etc/GMT+3",
3452n/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",
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",
3661n/a "Etc/GMT0",
3671n/a "Etc/Greenwich",
3682n/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",
3871n/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",
3975n/a "Europe/Ljubljana",
3981n/a "Europe/London",
3991n/a "Europe/Luxembourg",
4001n/a "Europe/Madrid",
4012n/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",
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",
4184n/a "Europe/Skopje",
4191n/a "Europe/Sofia",
4201n/a "Europe/Stockholm",
4211n/a "Europe/Tallinn",
4221n/a "Europe/Tirane",
4235n/a "Europe/Tiraspol",
4241n/a "Europe/Ulyanovsk",
4251n/a "Europe/Vaduz",
4262n/a "Europe/Vatican",
4273n/a "Europe/Vienna",
4281n/a "Europe/Vilnius",
4291n/a "Europe/Volgograd",
4303n/a "Europe/Warsaw",
4311n/a "Europe/Zagreb",
4321n/a "Europe/Zurich",
4331n/a "Factory",
4345n/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",
4471n/a "Pacific/Auckland",
4482n/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",
4621n/a "Pacific/Kanton",
4631n/a "Pacific/Kiritimati",
4641n/a "Pacific/Kosrae",
4652n/a "Pacific/Kwajalein",
4661n/a "Pacific/Majuro",
4671n/a "Pacific/Marquesas",
4681n/a "Pacific/Midway",
4691n/a "Pacific/Nauru",
4701n/a "Pacific/Niue",
4711n/a "Pacific/Norfolk",
4721n/a "Pacific/Noumea",
4731n/a "Pacific/Pago_Pago",
4742n/a "Pacific/Palau",
4751n/a "Pacific/Pitcairn",
4761n/a "Pacific/Pohnpei",
4771n/a "Pacific/Port_Moresby",
4781n/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",
4861n/a "Pacific/Yap",
48724n/a "UTC",
4881n/a "localtime"
48969914 ],
4907112 "minLength": 1,
491713n/a "type": "string"
49269914}
interval2 / 2
TimeInterval
1123984{
2123984 "enum": [
3663n/a "year",
467n/a "month",
558n/a "week",
6387n/a "day",
764n/a "hour"
8123984 ],
91323n/a "type": "string"
10123984}
filter3 / 3
1709n/a{
2709n/a "anyOf": [
3680n/a {
4680n/a "type": "string"
5680n/a },
629680 {
729680 "type": "null"
829680 }
9709n/a ],
10709n/a}
organization_id2 / 7
113250{
213250 "anyOf": [
301325 {
400 "format": "uuid4",
50n/a "type": "string",
601325 },
713250 {
813250 "items": {
913250 "format": "uuid4",
101325n/a "type": "string",
1113250 },
1213250 "type": "array"
1313250 },
1401325 {
1501325 "type": "null"
1601325 }
1713250 ],
1813250}
customer_id3 / 7
16878{
26878 "anyOf": [
30695 {
400 "format": "uuid4",
50n/a "type": "string"
60695 },
76878 {
86878 "items": {
97630 "format": "uuid4",
10763n/a "type": "string"
116878 },
126950 "type": "array"
136878 },
140695 {
150695 "type": "null"
160695 }
176878 ],
186878}
external_customer_id3 / 5
174n/a{
274n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
674627 {
774n/a "items": {
8199n/a "type": "string"
974n/a },
107010 "type": "array"
1174627 },
120701 {
130701 "type": "null"
140701 }
1574n/a ],
1674n/a}
meter_id4 / 4
16567{
26567 "anyOf": [
365310 {
46537 "format": "uuid4",
5660n/a "type": "string"
665310 },
73660 {
83660 "type": "null"
93660 }
106567 ],
116567}
name3 / 5
175n/a{
275n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
675626 {
775n/a "items": {
887n/a "type": "string"
975n/a },
107010 "type": "array"
1175626 },
120701 {
130701 "type": "null"
140701 }
1575n/a ],
1675n/a}
source4 / 7
164313{
264313 "anyOf": [
30656 {
40656 "$ref": "#/components/schemas/EventSource"
50656 },
664313 {
764313 "items": {
870317 "$ref": "#/components/schemas/EventSource"
964313 },
106560 "type": "array"
1164313 },
120656 {
130656 "type": "null"
140656 }
1564313 ],
1664313}
Referenced Components (1)3 of 3 keywords
EventSource3 of 3 keywords
1703673{
2703673 "enum": [
3649n/a "system",
454n/a "user"
5703673 ],
6708n/a "type": "string"
7703673}
event_type_id4 / 4
16776{
26776 "anyOf": [
36758 {
46756 "format": "uuid4",
5681n/a "type": "string"
66758 },
72681 {
82681 "type": "null"
92681 }
106776 ],
116776}
query3 / 3
1708n/a{
2708n/a "anyOf": [
3681n/a {
4681n/a "type": "string"
5681n/a },
627681 {
727681 "type": "null"
827681 }
9708n/a ],
10708n/a}
aggregate_fields2 / 2
1706n/a{
2706n/a "items": {
31000n/a "type": "string"
4706n/a },
5706n/a "type": "array"
6706n/a}
sorting4 / 6
165718{
265718 "anyOf": [
365718 {
465718 "items": {
587724 "$ref": "#/components/schemas/EventStatisticsSortProperty"
665718 },
76750 "type": "array"
865718 },
90675 {
100675 "type": "null"
110675 }
1265718 ],
1365718}
Referenced Components (1)3 of 3 keywords
EventStatisticsSortProperty3 of 3 keywords
187724{
287724 "enum": [
319n/a "name",
413n/a "-name",
516n/a "occurrences",
625n/a "-occurrences",
712n/a "total",
8625n/a "-total",
929n/a "average",
1020n/a "-average",
1132n/a "p95",
1231n/a "-p95",
1322n/a "p99",
1433n/a "-p99"
1587724 ],
16886n/a "type": "string"
1787724}
metadata4 / 13
MetadataQuery
1480{
2480 "anyOf": [
3480 {
4480 "additionalProperties": {
51170 "anyOf": [
68037 {
78037 "type": "string"
88037 },
90117 {
100117 "type": "integer"
110117 },
120117 {
130117 "type": "boolean"
140117 },
153780 {
16370 "items": {
171650 "type": "string"
18370 },
193780 "type": "array"
203780 },
210117 {
22037 "items": {
230165 "type": "integer"
24037 },
253780 "type": "array"
260117 },
270117 {
28037 "items": {
290165 "type": "boolean"
30037 },
313780 "type": "array"
320117 }
331170 ]
34480 },
35480 "type": "object"
36480 },
37048 {
38048 "type": "null"
39048 }
40480 ],
41480}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response30412ms
422Validation Error9856ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized163ms
500Internal Server Error201467ms
Examples3 / 5 used
Query
"UTC"timezone
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
[ "_cost.amount" ]aggregate_fields
[ "-total" ]sorting
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13160{
23160 "format": "uuid4",
3316n/a "type": "string"
43160}
Responses1 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Event not found.3006ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized162ms
files 5 operations 2 covered 3 partial 0 uncovered 0 not measured 88% #
Query Parameters10 of 18 keywords covered
organization_id2 / 7
#validinvalidschema
14610{
24610 "anyOf": [
30461 {
400 "format": "uuid4",
50n/a "type": "string",
60461 },
74610 {
84610 "items": {
94610 "format": "uuid4",
10461n/a "type": "string",
114610 },
124610 "type": "array"
134610 },
140461 {
150461 "type": "null"
160461 }
174610 ],
184610}
ids4 / 7
114512{
214512 "anyOf": [
30157 {
400 "format": "uuid4",
50n/a "type": "string"
60157 },
714512 {
814512 "items": {
928121 "format": "uuid4",
10302n/a "type": "string"
1114512 },
121570 "type": "array"
1314512 },
140157 {
150157 "type": "null"
160157 }
1714512 ],
1814512}
page2 / 2
115328{
21539 "exclusiveMinimum": 0,
316219 "type": "integer"
415328}
limit2 / 2
114726{
21475 "exclusiveMinimum": 0,
315221 "type": "integer"
414726}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response3096ms
422Validation Error465ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1012ms
500Internal Server Error51692ms
Examples2 / 4 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
Body76 of 79 keywords covered
application/json76 / 79
FileCreate
#validinvalidschema
1303497{
2303497 "oneOf": [
3122678 {
4122678 "$ref": "#/components/schemas/DownloadableFileCreate"
5122678 },
687713 {
787713 "$ref": "#/components/schemas/ProductMediaFileCreate"
887713 },
994706 {
1094706 "$ref": "#/components/schemas/OrganizationAvatarFileCreate"
1194706 }
12303497 ]
13303497}
Referenced Components (5)92 of 95 keywords
DownloadableFileCreate23 of 24 keywords
1122678{
2135655 "properties": {
357524 "checksum_sha256_base64": {
457524 "anyOf": [
570529 {
670529 "type": "string"
770529 },
850594 {
950594 "type": "null"
1050594 }
1157524 ],
1257524 },
1374230 "mime_type": {
1474230 "type": "string"
1574230 },
1674130 "name": {
1774130 "type": "string"
1874130 },
1969824 "organization_id": {
2069824 "anyOf": [
2169230 {
226920 "format": "uuid4",
2369230 "type": "string",
2469230 },
256716 {
266716 "type": "null"
276716 }
2869824 ],
2969824 },
30269517 "service": {
31269517 "const": "downloadable",
3275630 "type": "string"
33269517 },
3473636 "size": {
3573636 "type": "integer"
3673636 },
37526246 "upload": {
38526246 "$ref": "#/components/schemas/S3FileCreateMultipart"
39526246 },
4057224 "version": {
4157224 "anyOf": [
4270526 {
4370526 "type": "string"
4470526 },
4550294 {
4650294 "type": "null"
4750294 }
4857224 ],
4957224 }
50135655 },
5174941 "required": [
5277119 "name",
5377218 "mime_type",
5477218 "size",
5577218 "upload",
567864 "service"
5774941 ],
5879010 "type": "object"
59122678}
OrganizationAvatarFileCreate25 of 26 keywords
194706{
2104686 "properties": {
357524 "checksum_sha256_base64": {
457524 "anyOf": [
570529 {
670529 "type": "string"
770529 },
850594 {
950594 "type": "null"
1050594 }
1157524 ],
1257524 },
13467305 "mime_type": {
14467275 "pattern": "^image\\/(jpeg|png|gif|webp|svg\\+xml)$",
1574230 "type": "string"
16467305 },
1774130 "name": {
1874130 "type": "string"
1974130 },
2069824 "organization_id": {
2169824 "anyOf": [
2269230 {
236920 "format": "uuid4",
2469230 "type": "string",
2569230 },
266716 {
276716 "type": "null"
286716 }
2969824 ],
3069824 },
31244542 "service": {
32244542 "const": "organization_avatar",
3375630 "type": "string"
34244542 },
3570666 "size": {
3671230 "maximum": 1048576.0,
3773636 "type": "integer"
3870666 },
39526246 "upload": {
40526246 "$ref": "#/components/schemas/S3FileCreateMultipart"
41526246 },
4257224 "version": {
4357224 "anyOf": [
4470526 {
4570526 "type": "string"
4670526 },
4750294 {
4850294 "type": "null"
4950294 }
5057224 ],
5157224 }
52104686 },
5374941 "required": [
5477119 "name",
5577218 "mime_type",
5677218 "size",
5777218 "upload",
587864 "service"
5974941 ],
6079010 "type": "object"
6194706}
ProductMediaFileCreate25 of 26 keywords
187713{
297693 "properties": {
357524 "checksum_sha256_base64": {
457524 "anyOf": [
570529 {
670529 "type": "string"
770529 },
850594 {
950594 "type": "null"
1050594 }
1157524 ],
1257524 },
13467305 "mime_type": {
14467275 "pattern": "^image\\/(jpeg|png|gif|webp|svg\\+xml)$",
1574230 "type": "string"
16467305 },
1774130 "name": {
1874130 "type": "string"
1974130 },
2069824 "organization_id": {
2169824 "anyOf": [
2269230 {
236920 "format": "uuid4",
2469230 "type": "string",
2569230 },
266716 {
276716 "type": "null"
286716 }
2969824 ],
3069824 },
31237549 "service": {
32237549 "const": "product_media",
3375630 "type": "string"
34237549 },
3572151 "size": {
3672715 "maximum": 10485760.0,
3773636 "type": "integer"
3872151 },
39526246 "upload": {
40526246 "$ref": "#/components/schemas/S3FileCreateMultipart"
41526246 },
4257224 "version": {
4357224 "anyOf": [
4470526 {
4570526 "type": "string"
4670526 },
4750294 {
4850294 "type": "null"
4950294 }
5057224 ],
5157224 }
5297693 },
5374941 "required": [
5477119 "name",
5577218 "mime_type",
5677218 "size",
5777218 "upload",
587864 "service"
5974941 ],
6079010 "type": "object"
6187713}
S3FileCreateMultipart7 of 7 keywords
11578738{
21578630 "properties": {
31578630 "parts": {
41578540 "items": {
52796540 "$ref": "#/components/schemas/S3FileCreatePart"
61578540 },
7211890 "type": "array"
81578630 }
91578630 },
10220818 "required": [
11220818 "parts"
12220818 ],
13222690 "type": "object"
141578738}
S3FileCreatePart12 of 12 keywords
12796540{
22850396 "properties": {
3177672 "checksum_sha256_base64": {
4177672 "anyOf": [
56901158 {
66901158 "type": "string"
76901158 },
81086762 {
91086762 "type": "null"
101086762 }
11177672 ],
12177672 },
133120108 "chunk_end": {
143120108 "type": "integer"
153120108 },
163120108 "chunk_start": {
173120108 "type": "integer"
183120108 },
193120108 "number": {
203120108 "type": "integer"
213120108 }
222850396 },
23319254 "required": [
24322818 "number",
25322818 "chunk_start",
26322818 "chunk_end"
27319254 ],
28324690 "type": "object"
292796540}
Responses1 of 2 documented received
codedescriptionhitsavg
201File created.0never seen
422Validation Error5775ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error226929ms
400Bad Request25ms
401Unauthorized63ms
Examples3 / 3 used
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 Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
129210{
229210 "format": "uuid4",
3302n/a "type": "string"
429210}
Responses2 of 4 documented received
codedescriptionhitsavg
204File deleted.0never seen
403You don't have the permission to delete this file.0never seen
404File not found.2525ms
422Validation Error105ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized402ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13193{
23193 "format": "uuid4",
3322n/a "type": "string"
43193}
Body8 of 8 keywords covered
application/json8 / 8
FilePatch
127123{
27314 "properties": {
3776 "name": {
4776 "anyOf": [
55726 {
65726 "type": "string"
75726 },
82063 {
92063 "type": "null"
102063 }
11776 ],
12776 },
134310 "version": {
144310 "anyOf": [
151934 {
161934 "type": "string"
171934 },
182429 {
192429 "type": "null"
202429 }
214310 ],
224310 }
237314 },
242859 "type": "object"
2527123}
Responses2 of 4 documented received
codedescriptionhitsavg
200File updated.0never seen
403You don't have the permission to update this file.0never seen
404File not found.2606ms
422Validation Error479ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request45ms
401Unauthorized113ms
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13480{
23480 "format": "uuid4",
3348n/a "type": "string"
43480}
Body15 of 15 keywords covered
application/json15 / 15
FileUploadCompleted
114252{
214841 "properties": {
31805 "id": {
41805 "type": "string"
51805 },
615731 "parts": {
715726 "items": {
823626 "$ref": "#/components/schemas/S3FileUploadCompletedPart"
915726 },
101835 "type": "array"
1115731 },
121835 "path": {
131835 "type": "string"
141835 }
1514841 },
161836 "required": [
171854 "id",
181881 "path",
191881 "parts"
201836 ],
211895 "type": "object"
2214252}
Referenced Components (1)11 of 11 keywords
S3FileUploadCompletedPart11 of 11 keywords
123626{
224215 "properties": {
32515 "checksum_etag": {
42515 "type": "string"
52515 },
62524 "checksum_sha256_base64": {
72524 "anyOf": [
8115141 {
9115141 "type": "string"
10115141 },
11137119 {
12137119 "type": "null"
13137119 }
142524 ],
152524 },
162476 "number": {
172476 "type": "integer"
182476 }
1924215 },
202516 "required": [
212534 "number",
222561 "checksum_etag",
232561 "checksum_sha256_base64"
242516 ],
252575 "type": "object"
2623626}
Responses2 of 4 documented received
codedescriptionhitsavg
200File upload completed.0never seen
403You don't have the permission to update this file.0never seen
404File not found.1317ms
422Validation Error1195ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized122ms
400Bad Request864ms
integrations_apple 2 operations 0 covered 2 partial 0 uncovered 0 not measured 90% #
Query Parameters5 of 6 keywords covered
return_to2 / 3
#validinvalidschema
13n/a{
23n/a "anyOf": [
33n/a {
43n/a "type": "string"
53n/a },
603 {
703 "type": "null"
803 }
93n/a ],
103n/a}
attribution3 / 3
19n/a{
29n/a "anyOf": [
37n/a {
47n/a "type": "string"
57n/a },
627 {
727 "type": "null"
827 }
99n/a ],
109n/a}
Responses0 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden25194ms
500Internal Server Error7701ms
Body13 of 14 keywords covered
application/x-www-form-urlencoded13 / 14
Body_integrations_apple_integrations.apple.callback
#validinvalidschema
11470{
21190 "properties": {
381n/a "code": {
481n/a "anyOf": [
536n/a {
636n/a "type": "string"
736n/a },
84536 {
94536 "type": "null"
104536 }
1181n/a ],
1281n/a },
1378n/a "code_verifier": {
1478n/a "anyOf": [
1538n/a {
1638n/a "type": "string"
1738n/a },
184038 {
194038 "type": "null"
204038 }
2178n/a ],
2278n/a },
2383n/a "error": {
2483n/a "anyOf": [
2550n/a {
2650n/a "type": "string"
2750n/a },
283350 {
293350 "type": "null"
303350 }
3183n/a ],
3283n/a },
3382n/a "state": {
3482n/a "anyOf": [
3552n/a {
3652n/a "type": "string"
3752n/a },
383052 {
393052 "type": "null"
403052 }
4182n/a ],
4282n/a }
431190 },
44147n/a "type": "object"
451470}
Responses0 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2175ms
500Internal Server Error18810ms
integrations_discord 3 operations 2 covered 1 partial 0 uncovered 0 not measured 92% #
Query Parameters2 of 3 keywords covered
return_to2 / 3
#validinvalidschema
12n/a{
22n/a "anyOf": [
32n/a {
42n/a "type": "string"
52n/a },
602 {
702 "type": "null"
802 }
92n/a ],
102n/a}
Responses0 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request90160ms
401Unauthorized242ms
Query Parameters10 of 10 keywords covered
state1 / 1
#validinvalidschema
1327n/a{
2327n/a "type": "string"
3327n/a}
code3 / 3
175n/a{
275n/a "anyOf": [
373n/a {
473n/a "type": "string"
573n/a },
6273 {
7273 "type": "null"
8273 }
975n/a ],
1075n/a}
code_verifier3 / 3
169n/a{
269n/a "anyOf": [
364n/a {
464n/a "type": "string"
564n/a },
6564 {
7564 "type": "null"
8564 }
969n/a ],
1069n/a}
error3 / 3
171n/a{
271n/a "anyOf": [
366n/a {
466n/a "type": "string"
566n/a },
6566 {
7566 "type": "null"
8566 }
971n/a ],
1071n/a}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error14ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3274ms
Query Parameters1 of 1 keywords covered
guild_token1 / 1
#validinvalidschema
1302n/a{
2302n/a "type": "string"
3302n/a}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error14ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized3024ms
integrations_github 2 operations 1 covered 1 partial 0 uncovered 0 not measured 90% #
Query Parameters7 of 9 keywords covered
payment_intent_id2 / 3
#validinvalidschema
11n/a{
21n/a "anyOf": [
31n/a {
41n/a "type": "string"
51n/a },
601 {
701 "type": "null"
801 }
91n/a ],
101n/a}
return_to2 / 3
155n/a{
255n/a "anyOf": [
355n/a {
455n/a "type": "string"
555n/a },
6055 {
7055 "type": "null"
8055 }
955n/a ],
1055n/a}
attribution3 / 3
13n/a{
23n/a "anyOf": [
32n/a {
42n/a "type": "string"
52n/a },
612 {
712 "type": "null"
812 }
93n/a ],
103n/a}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response54210ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error2760ms
Query Parameters12 of 12 keywords covered
code3 / 3
#validinvalidschema
173n/a{
273n/a "anyOf": [
367n/a {
467n/a "type": "string"
567n/a },
6667 {
7667 "type": "null"
8667 }
973n/a ],
1073n/a}
code_verifier3 / 3
158n/a{
258n/a "anyOf": [
356n/a {
456n/a "type": "string"
556n/a },
6256 {
7256 "type": "null"
8256 }
958n/a ],
1058n/a}
state3 / 3
168n/a{
268n/a "anyOf": [
362n/a {
462n/a "type": "string"
562n/a },
6662 {
7662 "type": "null"
8662 }
968n/a ],
1068n/a}
error3 / 3
160n/a{
260n/a "anyOf": [
354n/a {
454n/a "type": "string"
554n/a },
6654 {
7654 "type": "null"
8654 }
960n/a ],
1060n/a}
Responses0 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error31198ms
400Bad Request2515ms
integrations_github_repository_benefit 5 operations 5 covered 0 partial 0 uncovered 0 not measured 100% #
Responses1 of 1 documented received
codedescriptionhitsavg
200Successful Response1084ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1962ms
Responses0 of 1 documented received
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found11728ms
401Unauthorized1532ms
Query Parameters3 of 3 keywords covered
return_to3 / 3
#validinvalidschema
171n/a{
271n/a "anyOf": [
369n/a {
469n/a "type": "string"
569n/a },
6269 {
7269 "type": "null"
8269 }
971n/a ],
1071n/a}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response64115ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized302ms
Query Parameters12 of 12 keywords covered
code3 / 3
#validinvalidschema
173n/a{
273n/a "anyOf": [
366n/a {
466n/a "type": "string"
566n/a },
6766 {
7766 "type": "null"
8766 }
973n/a ],
1073n/a}
code_verifier3 / 3
168n/a{
268n/a "anyOf": [
358n/a {
458n/a "type": "string"
558n/a },
61058 {
71058 "type": "null"
81058 }
968n/a ],
1068n/a}
state3 / 3
181n/a{
281n/a "anyOf": [
376n/a {
476n/a "type": "string"
576n/a },
6576 {
7576 "type": "null"
8576 }
981n/a ],
1081n/a}
error3 / 3
175n/a{
275n/a "anyOf": [
364n/a {
464n/a "type": "string"
564n/a },
61164 {
71164 "type": "null"
81164 }
975n/a ],
1075n/a}
Responses0 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error19195ms
400Bad Request2355ms
401Unauthorized812ms
Responses0 of 1 documented received
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error1079ms
401Unauthorized1962ms
integrations_google 2 operations 1 covered 1 partial 0 uncovered 0 not measured 94% #
Query Parameters5 of 6 keywords covered
return_to2 / 3
#validinvalidschema
13n/a{
23n/a "anyOf": [
33n/a {
43n/a "type": "string"
53n/a },
603 {
703 "type": "null"
803 }
93n/a ],
103n/a}
attribution3 / 3
111n/a{
211n/a "anyOf": [
39n/a {
49n/a "type": "string"
59n/a },
629 {
729 "type": "null"
829 }
911n/a ],
1011n/a}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response7043ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error9701ms
Query Parameters12 of 12 keywords covered
code3 / 3
#validinvalidschema
159n/a{
259n/a "anyOf": [
357n/a {
457n/a "type": "string"
557n/a },
6257 {
7257 "type": "null"
8257 }
959n/a ],
1059n/a}
code_verifier3 / 3
166n/a{
266n/a "anyOf": [
364n/a {
464n/a "type": "string"
564n/a },
6264 {
7264 "type": "null"
8264 }
966n/a ],
1066n/a}
state3 / 3
170n/a{
270n/a "anyOf": [
368n/a {
468n/a "type": "string"
568n/a },
6268 {
7268 "type": "null"
8268 }
970n/a ],
1070n/a}
error3 / 3
161n/a{
261n/a "anyOf": [
359n/a {
459n/a "type": "string"
559n/a },
6259 {
7259 "type": "null"
8259 }
961n/a ],
1061n/a}
Responses0 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error2674ms
400Bad Request3094ms
license_keys 7 operations 2 covered 5 partial 0 uncovered 0 not measured 80% #
Query Parameters10 of 18 keywords covered
organization_id2 / 7
#validinvalidschema
17180{
27180 "anyOf": [
30718 {
400 "format": "uuid4",
50n/a "type": "string",
60718 },
77180 {
87180 "items": {
97180 "format": "uuid4",
10718n/a "type": "string",
117180 },
127180 "type": "array"
137180 },
140718 {
150718 "type": "null"
160718 }
177180 ],
187180}
benefit_id4 / 7
16255{
26255 "anyOf": [
30630 {
400 "format": "uuid4",
50n/a "type": "string",
60630 },
76255 {
86255 "items": {
96441 "format": "uuid4",
10645n/a "type": "string",
116255 },
126300 "type": "array"
136255 },
140630 {
150630 "type": "null"
160630 }
176255 ],
186255}
page2 / 2
127318{
22732 "exclusiveMinimum": 0,
327516 "type": "integer"
427318}
limit2 / 2
126422{
22642 "exclusiveMinimum": 0,
326620 "type": "integer"
426422}
Responses3 of 4 documented received
codedescriptionhitsavg
200Successful Response6087ms
401Not authorized to manage license key.722ms
404License key not found.0never seen
422Validation Error305ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error81482ms
Examples2 / 4 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
Body25 of 29 keywords covered
application/json25 / 29
LicenseKeyActivate
#validinvalidschema
143442{
243734 "properties": {
317611 "conditions": {
41296 "additionalProperties": {
53986 "anyOf": [
6138266 {
71440 "maxLength": 500,
81386 "minLength": 1,
9144260 "type": "string"
10138266 },
11111293 {
12111293 "type": "integer"
13111293 },
14152252 {
15152252 "type": "number"
16152252 },
17108296 {
18108296 "type": "boolean"
19108296 }
203986 ]
211296 },
221820 "maxProperties": 50,
231332 "propertyNames": {
244031 "maxLength": 40,
254031 "minLength": 1
261332 },
271825 "type": "object"
2817611 },
294655 "key": {
304655 "type": "string"
314655 },
324619 "label": {
334619 "type": "string"
344619 },
3520312 "meta": {
361493 "additionalProperties": {
374906 "anyOf": [
38117379 {
391194 "maxLength": 500,
401212 "minLength": 1,
41123373 "type": "string"
42117379 },
43139357 {
44139357 "type": "integer"
45139357 },
46179317 {
47179317 "type": "number"
48179317 },
49194302 {
50194302 "type": "boolean"
51194302 }
524906 ]
531493 },
542060 "maxProperties": 50,
551502 "propertyNames": {
564951 "maxLength": 40,
574951 "minLength": 1
581502 },
592069 "type": "object"
6020312 },
614655 "organization_id": {
624650 "format": "uuid4",
634655 "type": "string"
644655 }
6543734 },
664683 "required": [
674701 "key",
684701 "organization_id",
694701 "label"
704683 ],
714715 "type": "object"
7243442}
Responses2 of 4 documented received
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.38925ms
422Validation Error695ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized323ms
500Internal Server Error131378ms
400Bad Request285ms
Body6 of 8 keywords covered
application/json6 / 8
LicenseKeyDeactivate
#validinvalidschema
115123{
215415 "properties": {
31635 "activation_id": {
41630 "format": "uuid4",
51635 "type": "string"
61635 },
71635 "key": {
81635 "type": "string"
91635 },
101635 "organization_id": {
111630 "format": "uuid4",
121635 "type": "string"
131635 }
1415415 },
151663 "required": [
161681 "key",
171681 "organization_id",
181681 "activation_id"
191663 ],
201695 "type": "object"
2115123}
Responses2 of 3 documented received
codedescriptionhitsavg
204License key activation deactivated.0never seen
404License key not found.1346ms
422Validation Error975ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized172ms
400Bad Request924ms
Body26 of 32 keywords covered
application/json26 / 32
LicenseKeyValidate
#validinvalidschema
118948{
219735 "properties": {
31204 "activation_id": {
41204 "anyOf": [
58737 {
6870 "format": "uuid4",
78737 "type": "string"
88737 },
93391 {
103391 "type": "null"
113391 }
121204 ],
131204 },
142074 "benefit_id": {
152074 "anyOf": [
1619021 {
171900 "format": "uuid4",
1819021 "type": "string",
1919021 },
2017194 {
2117194 "type": "null"
2217194 }
232074 ],
242074 },
251058 "conditions": {
26433 "additionalProperties": {
271493 "anyOf": [
2845107 {
29480 "maxLength": 500,
30453 "minLength": 1,
3148104 "type": "string"
3245107 },
3335117 {
3435117 "type": "integer"
3535117 },
3639113 {
3739113 "type": "number"
3839113 },
396587 {
406587 "type": "boolean"
416587 }
421493 ]
43433 },
441080 "maxProperties": 50,
45442 "propertyNames": {
461511 "maxLength": 40,
471511 "minLength": 1
48442 },
491085 "type": "object"
501058 },
511174 "customer_id": {
521174 "anyOf": [
536952 {
54690 "format": "uuid4",
556952 "type": "string"
566952 },
574873 {
584873 "type": "null"
594873 }
601174 ],
611174 },
621125 "increment_usage": {
631125 "anyOf": [
643186 {
653186 "type": "integer"
663186 },
678136 {
688136 "type": "null"
698136 }
701125 ],
711125 },
722205 "key": {
732205 "type": "string"
742205 },
752265 "organization_id": {
762260 "format": "uuid4",
772265 "type": "string"
782265 }
7919735 },
802248 "required": [
812257 "key",
822311 "organization_id"
832248 ],
842325 "type": "object"
8518948}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404License key not found.1816ms
422Validation Error1195ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized92ms
400Bad Request866ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13027{
23027 "format": "uuid4",
3309n/a "type": "string"
43027}
Responses3 of 4 documented received
codedescriptionhitsavg
200Successful Response0never seen
401Not authorized to manage license key.222ms
404License key not found.2806ms
422Validation Error75ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13634{
23634 "format": "uuid4",
3367n/a "type": "string"
43634}
Body21 of 21 keywords covered
application/json21 / 21
LicenseKeyUpdate
122335{
210530 "properties": {
3856 "expires_at": {
4856 "anyOf": [
57615 {
6762 "format": "date-time",
77813 "type": "string"
87615 },
9982 {
10982 "type": "null"
11982 }
12856 ],
13856 },
14957 "limit_activations": {
15957 "anyOf": [
168022 {
17821 "exclusiveMinimum": 0.0,
18821 "maximum": 1000.0,
198220 "type": "integer"
208022 },
211587 {
221587 "type": "null"
231587 }
24957 ],
25957 },
261046 "limit_usage": {
271046 "anyOf": [
288129 {
29821 "exclusiveMinimum": 0.0,
308228 "type": "integer"
318129 },
322387 {
332387 "type": "null"
342387 }
351046 ],
361046 },
37795 "status": {
38795 "anyOf": [
392559 {
402559 "$ref": "#/components/schemas/LicenseKeyStatus"
412559 },
425430 {
435430 "type": "null"
445430 }
45795 ]
46795 },
47876 "usage": {
48876 "type": "integer"
49876 }
5010530 },
512535 "type": "object"
5222335}
Referenced Components (1)3 of 3 keywords
LicenseKeyStatus3 of 3 keywords
12559{
22559 "enum": [
312n/a "granted",
42n/a "revoked",
511n/a "disabled"
62559 ],
72658 "type": "string"
82559}
Responses3 of 4 documented received
codedescriptionhitsavg
200Successful Response0never seen
401Not authorized to manage license key.113ms
404License key not found.2147ms
422Validation Error825ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request606ms
Examples1 / 1 used
Body: application/json
0LicenseKeyUpdate.usage
Path Parameters3 of 4 keywords covered
id1 / 2
#validinvalidschema
13160{
23160 "format": "uuid4",
3316n/a "type": "string"
43160}
activation_id2 / 2
130214{
230214 "format": "uuid4",
3316n/a "type": "string"
430214}
Responses3 of 4 documented received
codedescriptionhitsavg
200Successful Response0never seen
401Not authorized to manage license key.212ms
404License key not found.2816ms
422Validation Error144ms
login_code 2 operations 0 covered 2 partial 0 uncovered 0 not measured 91% #
Query Parameters5 of 5 keywords covered
email2 / 2
#validinvalidschema
15412{
25412 "format": "email",
366n/a "type": "string"
45412}
return_to3 / 3
121n/a{
221n/a "anyOf": [
320n/a {
420n/a "type": "string"
520n/a },
6120 {
7120 "type": "null"
8120 }
921n/a ],
1021n/a}
Body3 of 4 keywords covered
application/x-www-form-urlencoded3 / 4
Body_login_code_authenticate_login_code
1630{
263n/a "properties": {
363n/a "code": {
463n/a "type": "string"
563n/a }
663n/a },
7630 "required": [
8630 "code"
9630 ],
1063n/a "type": "object"
11630}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error667ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request14ms
Body47 of 51 keywords covered
application/json47 / 51
LoginCodeRequest
#validinvalidschema
114578{
214967 "properties": {
38454 "attribution": {
48454 "anyOf": [
55187 {
65187 "$ref": "#/components/schemas/UserSignupAttribution"
75187 },
833105 {
933105 "type": "null"
1033105 }
118454 ]
128454 },
132039 "email": {
142084 "format": "email",
152075 "type": "string"
162039 },
171444 "return_to": {
181444 "anyOf": [
1924124 {
2024124 "type": "string"
2124124 },
2212028 {
2312028 "type": "null"
2412028 }
251444 ],
261444 }
2714967 },
282126 "required": [
292126 "email"
302126 ],
312185 "type": "object"
3214578}
Referenced Components (1)49 of 53 keywords
UserSignupAttribution49 of 53 keywords
15187{
25050 "properties": {
3794 "campaign": {
4794 "anyOf": [
5677 {
6677 "type": "string"
7677 },
87310 {
97310 "type": "null"
107310 }
11794 ],
12794 },
13796 "from_storefront": {
14796 "anyOf": [
157114 {
16710 "format": "uuid4",
177114 "type": "string"
187114 },
19877 {
20877 "type": "null"
21877 }
22796 ],
23796 },
24687 "host": {
25687 "anyOf": [
26174 {
27174 "type": "string"
28174 },
29678 {
30678 "type": "null"
31678 }
32687 ],
33687 },
34727 "intent": {
35727 "anyOf": [
361366 {
371366 "enum": [
382n/a "creator",
393n/a "pledge",
401n/a "purchase",
411n/a "subscription",
426n/a "newsletter_subscription"
431366 ],
441465 "type": "string"
451366 },
465920 {
475920 "type": "null"
485920 }
49727 ],
50727 },
51724 "order": {
52724 "anyOf": [
536610 {
54660 "format": "uuid4",
556610 "type": "string"
566610 },
57670 {
58670 "type": "null"
59670 }
60724 ],
61724 },
62714 "path": {
63714 "anyOf": [
64570 {
65570 "type": "string"
66570 },
67669 {
68669 "type": "null"
69669 }
70714 ],
71714 },
72724 "pledge": {
73724 "anyOf": [
74715 {
75710 "format": "uuid4",
76715 "type": "string"
77715 },
78175 {
79175 "type": "null"
80175 }
81724 ],
82724 },
83696 "subscription": {
84696 "anyOf": [
85687 {
86680 "format": "uuid4",
87687 "type": "string"
88687 },
89174 {
90174 "type": "null"
91174 }
92696 ],
93696 },
94774 "utm_campaign": {
95774 "anyOf": [
96378 {
97378 "type": "string"
98378 },
99747 {
100747 "type": "null"
101747 }
102774 ],
103774 },
104674 "utm_medium": {
105674 "anyOf": [
106368 {
107368 "type": "string"
108368 },
109647 {
110647 "type": "null"
111647 }
112674 ],
113674 },
114664 "utm_source": {
115664 "anyOf": [
116664 {
117664 "type": "string"
118664 },
1196010 {
1206010 "type": "null"
1216010 }
122664 ],
123664 }
1245050 },
12510137 "type": "object"
1265187}
Responses2 of 2 documented received
codedescriptionhitsavg
202Successful Response3284ms
422Validation Error2733ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request641ms
members 1 operation 0 covered 1 partial 0 uncovered 0 not measured 84% #
Query Parameters11 of 13 keywords covered
customer_id3 / 3
#validinvalidschema
1152n/a{
2152n/a "anyOf": [
3144n/a {
4144n/a "type": "string"
5144n/a },
68144 {
78144 "type": "null"
88144 }
9152n/a ],
10152n/a}
page2 / 2
124621{
22462 "exclusiveMinimum": 0,
324819 "type": "integer"
424621}
limit2 / 2
120730{
22075 "exclusiveMinimum": 0,
321225 "type": "integer"
420730}
sorting4 / 6
111230{
211230 "anyOf": [
311230 {
411230 "items": {
558354 "$ref": "#/components/schemas/MemberSortProperty"
611230 },
71420 "type": "array"
811230 },
90142 {
100142 "type": "null"
110142 }
1211230 ],
1311230}
Referenced Components (1)3 of 3 keywords
MemberSortProperty3 of 3 keywords
158354{
258354 "enum": [
3279n/a "created_at",
4304n/a "-created_at"
558354 ],
6610n/a "type": "string"
758354}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response3677ms
422Validation Error575ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found986ms
401Unauthorized642ms
500Internal Server Error111432ms
Examples3 / 3 used
Query
1page
10limit
[ "-created_at" ]sorting
meters 5 operations 0 covered 5 partial 0 uncovered 0 not measured 80% #
Query Parameters20 of 36 keywords covered
organization_id2 / 7
#validinvalidschema
17760{
27760 "anyOf": [
30776 {
400 "format": "uuid4",
50n/a "type": "string",
60776 },
77760 {
87760 "items": {
97760 "format": "uuid4",
10776n/a "type": "string",
117760 },
127760 "type": "array"
137760 },
140776 {
150776 "type": "null"
160776 }
177760 ],
187760}
query3 / 3
1191n/a{
2191n/a "anyOf": [
3179n/a {
4179n/a "type": "string"
5179n/a },
612179 {
712179 "type": "null"
812179 }
9191n/a ],
10191n/a}
is_archived3 / 3
121421{
221421 "anyOf": [
320134 {
420134 "type": "boolean"
520134 },
613222 {
713222 "type": "null"
813222 }
921421 ],
1021421}
page2 / 2
131331{
23135 "exclusiveMinimum": 0,
331826 "type": "integer"
431331}
limit2 / 2
132529{
23254 "exclusiveMinimum": 0,
332925 "type": "integer"
432529}
sorting4 / 6
114027{
214027 "anyOf": [
314027 {
414027 "items": {
546933 "$ref": "#/components/schemas/MeterSortProperty"
614027 },
71670 "type": "array"
814027 },
90167 {
100167 "type": "null"
110167 }
1214027 ],
1314027}
Referenced Components (1)3 of 3 keywords
MeterSortProperty3 of 3 keywords
146933{
246933 "enum": [
3110n/a "created_at",
483n/a "-created_at",
5150n/a "name",
6126n/a "-name"
746933 ],
8483n/a "type": "string"
946933}
metadata4 / 13
MetadataQuery
11360{
21360 "anyOf": [
31360 {
41360 "additionalProperties": {
53350 "anyOf": [
6166169 {
7166169 "type": "string"
8166169 },
90335 {
100335 "type": "integer"
110335 },
120335 {
130335 "type": "boolean"
140335 },
15169166 {
161690 "items": {
1711540 "type": "string"
181690 },
19169166 "type": "array"
20169166 },
210335 {
220169 "items": {
2301154 "type": "integer"
240169 },
25169166 "type": "array"
260335 },
270335 {
280169 "items": {
2901154 "type": "boolean"
300169 },
31169166 "type": "array"
320335 }
333350 ]
341360 },
351360 "type": "object"
361360 },
370136 {
380136 "type": "null"
390136 }
401360 ],
411360}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response5637ms
422Validation Error865ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1042ms
500Internal Server Error231497ms
Examples3 / 5 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "name" ]sorting
Body63 of 65 keywords covered
application/json63 / 65
MeterCreate
#validinvalidschema
1354287{
2360271 "properties": {
356861 "aggregation": {
456861 "oneOf": [
592537 {
692537 "$ref": "#/components/schemas/CountAggregation"
792537 },
8414215 {
9414215 "$ref": "#/components/schemas/PropertyAggregation"
10414215 },
1166563 {
1266563 "$ref": "#/components/schemas/UniqueAggregation"
1366563 }
1456861 ],
1556861 },
16455174 "filter": {
17455174 "$ref": "#/components/schemas/Filter",
18455174 },
1943915 "metadata": {
20715 "additionalProperties": {
212427 "anyOf": [
2288161 {
23920 "maxLength": 500,
24884 "minLength": 1,
2592157 "type": "string"
2688161 },
2734215 {
2834215 "type": "integer"
2934215 },
3077172 {
3177172 "type": "number"
3277172 },
3377172 {
3477172 "type": "boolean"
3577172 }
362427 ]
37715 },
384440 "maxProperties": 50,
39724 "propertyNames": {
402472 "maxLength": 40,
412472 "minLength": 1
42724 },
4344410 "type": "object"
4443915 },
4561613 "name": {
466163 "minLength": 3,
4761910 "type": "string"
4861613 },
496199 "organization_id": {
506199 "anyOf": [
5161711 {
526171 "format": "uuid4",
5361810 "type": "string",
5461711 },
552626 {
562626 "type": "null"
572626 }
586199 ],
596199 }
60360271 },
616256 "required": [
626292 "name",
636292 "filter",
646292 "aggregation"
656256 ],
6663110 "type": "object"
67354287}
Referenced Components (7)54 of 54 keywords
CountAggregation5 of 5 keywords
192537{
224526 "properties": {
324526 "func": {
424526 "const": "count",
553020 "type": "string"
624526 }
724526 },
861811 "type": "object"
992537}
Filter11 of 11 keywords
1595677{
2608229 "properties": {
3628205 "clauses": {
4628185 "items": {
5421222 "anyOf": [
6281362 {
7281362 "$ref": "#/components/schemas/FilterClause"
8281362 },
9140503 {
10140503 "$ref": "#/components/schemas/Filter"
11140503 }
12421222 ]
13628185 },
1481320 "type": "array"
15628205 },
1680424 "conjunction": {
1780424 "$ref": "#/components/schemas/FilterConjunction"
1880424 }
19608229 },
20824418 "required": [
21828414 "conjunction",
22833409 "clauses"
23824418 ],
24124230 "type": "object"
25595677}
FilterClause15 of 15 keywords
1281362{
2293112 "properties": {
337724 "operator": {
437724 "$ref": "#/components/schemas/FilterOperator"
537724 },
635150 "property": {
735150 "type": "string"
835150 },
936338 "value": {
1036338 "anyOf": [
11165236 {
121657 "maxLength": 1000,
13172229 "type": "string"
14165236 },
15138263 {
161485 "maximum": 2147483647.0,
171494 "minimum": -2147483648.0,
18147254 "type": "integer"
19138263 },
2060341 {
2160341 "type": "boolean"
2260341 }
2336338 ],
2436338 }
25293112 },
26393230 "required": [
27401222 "property",
28401222 "operator",
29401222 "value"
30393230 ],
3162320 "type": "object"
32281362}
FilterConjunction3 of 3 keywords
180424{
280424 "enum": [
3561n/a "and",
4243n/a "or"
580424 ],
680820 "type": "string"
780424}
FilterOperator3 of 3 keywords
137724{
237724 "enum": [
3122n/a "eq",
440n/a "ne",
543n/a "gt",
637n/a "gte",
750n/a "lt",
822n/a "lte",
937n/a "like",
1026n/a "not_like"
1137724 ],
1238120 "type": "string"
1337724}
PropertyAggregation9 of 9 keywords
1414215{
2418134 "properties": {
3426124 "func": {
4426124 "enum": [
5426n/a "sum",
60n/a "max",
70n/a "min",
80n/a "avg"
9426124 ],
1053020 "type": "string"
11426124 },
1249220 "property": {
1349220 "type": "string"
1449220 }
15418134 },
16510108 "required": [
1755068 "func",
18512106 "property"
19510108 ],
2061811 "type": "object"
21414215}
UniqueAggregation8 of 8 keywords
166563{
268484 "properties": {
376474 "func": {
476474 "const": "unique",
553020 "type": "string"
676474 },
749220 "property": {
849220 "type": "string"
949220 }
1068484 },
11512106 "required": [
12512106 "property"
13512106 ],
1461811 "type": "object"
1566563}
Responses2 of 2 documented received
codedescriptionhitsavg
201Meter created.17212ms
422Validation Error4536ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized93ms
400Bad Request45ms
500Internal Server Error251594ms
Examples3 / 3 used
Body: application/json
"count"CountAggregation.func
"unique"UniqueAggregation.func
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"MeterCreate.organization_id.examples[0]
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13090{
23090 "format": "uuid4",
3309n/a "type": "string"
43090}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response2575ms
404Meter not found.286ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized242ms
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
14390{
24390 "format": "uuid4",
3439n/a "type": "string"
44390}
Body67 of 69 keywords covered
application/json67 / 69
MeterUpdate
1280148{
2122143 "properties": {
320931 "aggregation": {
420931 "anyOf": [
548192 {
648192 "oneOf": [
723217 {
823217 "$ref": "#/components/schemas/CountAggregation"
923217 },
1014226 {
1114226 "$ref": "#/components/schemas/PropertyAggregation"
1214226 },
1313227 {
1413227 "$ref": "#/components/schemas/UniqueAggregation"
1513227 }
1648192 ]
1748192 },
1816179 {
1916179 "type": "null"
2016179 }
2120931 ],
2220931 },
2314285 "filter": {
2414285 "anyOf": [
2553174 {
2653174 "$ref": "#/components/schemas/Filter",
2753174 },
2889138 {
2989138 "type": "null"
3089138 }
3114285 ],
3214285 },
3319816 "is_archived": {
3419816 "anyOf": [
3513201 {
3613201 "type": "boolean"
3713201 },
3818529 {
3918529 "type": "null"
4018529 }
4119816 ],
4219816 },
432187 "metadata": {
44282 "additionalProperties": {
45972 "anyOf": [
462475 {
47260 "maxLength": 500,
48242 "minLength": 1,
492673 "type": "string"
502475 },
514059 {
524059 "type": "integer"
534059 },
544950 {
554950 "type": "number"
564950 },
572475 {
582475 "type": "boolean"
592475 }
60972 ]
61282 },
622200 "maxProperties": 50,
63282 "propertyNames": {
64981 "maxLength": 40,
65981 "minLength": 1
66282 },
672205 "type": "object"
682187 },
692105 "name": {
702105 "anyOf": [
7120213 {
722021 "minLength": 3,
7320312 "type": "string"
7420213 },
758207 {
768207 "type": "null"
778207 }
782105 ],
792105 }
80122143 },
814235 "type": "object"
82280148}
Referenced Components (7)54 of 54 keywords
CountAggregation5 of 5 keywords
123217{
21251 "properties": {
31251 "func": {
41251 "const": "count",
55310 "type": "string"
61251 }
71251 },
874166 "type": "object"
923217}
Filter11 of 11 keywords
178306{
282114 "properties": {
392102 "clauses": {
49292 "items": {
56196 "anyOf": [
636121 {
736121 "$ref": "#/components/schemas/FilterClause"
836121 },
925132 {
1025132 "$ref": "#/components/schemas/Filter"
1125132 }
126196 ]
139292 },
1418410 "type": "array"
1592102 },
1618212 "conjunction": {
1718212 "$ref": "#/components/schemas/FilterConjunction"
1818212 }
1982114 },
2019289 "required": [
2119487 "conjunction",
2219487 "clauses"
2319289 ],
24281103 "type": "object"
2578306}
FilterClause15 of 15 keywords
136121{
24241 "properties": {
36912 "operator": {
46912 "$ref": "#/components/schemas/FilterOperator"
56912 },
67110 "property": {
77110 "type": "string"
87110 },
96219 "value": {
106219 "anyOf": [
115031 {
12502 "maxLength": 1000,
135229 "type": "string"
145031 },
15873 {
16122 "maximum": 2147483647.0,
17122 "minimum": -2147483648.0,
181269 "type": "integer"
19873 },
20477 {
21477 "type": "boolean"
22477 }
236219 ],
246219 }
254241 },
267770 "required": [
278166 "property",
288166 "operator",
298166 "value"
307770 ],
3114710 "type": "object"
3236121}
FilterConjunction3 of 3 keywords
118212{
218212 "enum": [
3160n/a "and",
422n/a "or"
518212 ],
618410 "type": "string"
718212}
FilterOperator3 of 3 keywords
16912{
26912 "enum": [
349n/a "eq",
43n/a "ne",
53n/a "gt",
62n/a "gte",
72n/a "lt",
83n/a "lte",
93n/a "like",
104n/a "not_like"
116912 ],
127110 "type": "string"
136912}
PropertyAggregation9 of 9 keywords
114226{
21648 "properties": {
32142 "func": {
42142 "enum": [
521n/a "sum",
60n/a "max",
70n/a "min",
80n/a "avg"
92142 ],
105310 "type": "string"
112142 },
123311 "property": {
133311 "type": "string"
143311 }
151648 },
164331 "required": [
176311 "func",
184430 "property"
194331 ],
2074166 "type": "object"
2114226}
UniqueAggregation8 of 8 keywords
113227{
21450 "properties": {
31845 "func": {
41845 "const": "unique",
55310 "type": "string"
61845 },
73311 "property": {
83311 "type": "string"
93311 }
101450 },
114430 "required": [
124430 "property"
134430 ],
1474166 "type": "object"
1513227}
Responses3 of 3 documented received
codedescriptionhitsavg
200Meter updated.2458ms
404Meter not found.178ms
422Validation Error1625ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized133ms
500Internal Server Error22009ms
Examples2 / 2 used
Body: application/json
"count"CountAggregation.func
"unique"UniqueAggregation.func
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
15590{
25590 "format": "uuid4",
3559n/a "type": "string"
45590}
Query Parameters21 of 36 keywords covered
start_timestamp2 / 2
152036{
252036 "format": "date-time",
3556n/a "type": "string"
452036}
end_timestamp2 / 2
152136{
252136 "format": "date-time",
3557n/a "type": "string"
452136}
interval2 / 2
TimeInterval
152136{
252136 "enum": [
386n/a "year",
445n/a "month",
532n/a "week",
6314n/a "day",
744n/a "hour"
852136 ],
9557n/a "type": "string"
1052136}
customer_id3 / 7
11064{
21064 "anyOf": [
30110 {
400 "format": "uuid4",
50n/a "type": "string"
60110 },
71064 {
81064 "items": {
91460 "format": "uuid4",
10146n/a "type": "string"
111064 },
121100 "type": "array"
131064 },
140110 {
150110 "type": "null"
160110 }
171064 ],
181064}
external_customer_id3 / 5
124n/a{
224n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
62481 {
724n/a "items": {
860n/a "type": "string"
924n/a },
101050 "type": "array"
112481 },
120105 {
130105 "type": "null"
140105 }
1524n/a ],
1624n/a}
customer_aggregation_function5 / 5
111732{
211732 "anyOf": [
39356 {
49356 "$ref": "#/components/schemas/AggregationFunction"
59356 },
624125 {
724125 "type": "null"
824125 }
911732 ],
1011732}
Referenced Components (1)3 of 3 keywords
AggregationFunction3 of 3 keywords
19356{
29356 "enum": [
356n/a "count",
413n/a "sum",
56n/a "max",
64n/a "min",
74n/a "avg",
810n/a "unique"
99356 ],
10125n/a "type": "string"
119356}
metadata4 / 13
MetadataQuery
1330{
2330 "anyOf": [
3330 {
4330 "additionalProperties": {
5710 "anyOf": [
65021 {
75021 "type": "string"
85021 },
9071 {
10071 "type": "integer"
11071 },
12071 {
13071 "type": "boolean"
14071 },
152150 {
16210 "items": {
171410 "type": "string"
18210 },
192150 "type": "array"
202150 },
21071 {
22021 "items": {
230141 "type": "integer"
24021 },
252150 "type": "array"
26071 },
27071 {
28021 "items": {
290141 "type": "boolean"
30021 },
312150 "type": "array"
32071 }
33710 ]
34330 },
35330 "type": "object"
36330 },
37033 {
38033 "type": "null"
39033 }
40330 ],
41330}
Responses3 of 3 documented received
codedescriptionhitsavg
200Successful Response2798ms
404Meter not found.377ms
422Validation Error2315ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized83ms
500Internal Server Error41498ms
metrics 2 operations 1 covered 1 partial 0 uncovered 0 not measured 48% #
Query Parameters21 of 37 keywords covered
start_date2 / 2
#validinvalidschema
198131{
298131 "format": "date",
31012n/a "type": "string"
498131}
end_date2 / 2
198230{
298230 "format": "date",
31012n/a "type": "string"
498230}
timezone3 / 3
158215{
258215 "enum": [
333n/a "Africa/Abidjan",
40n/a "Africa/Accra",
50n/a "Africa/Addis_Ababa",
62n/a "Africa/Algiers",
72n/a "Africa/Asmara",
80n/a "Africa/Bamako",
91n/a "Africa/Bangui",
100n/a "Africa/Banjul",
110n/a "Africa/Bissau",
120n/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",
250n/a "Africa/Gaborone",
261n/a "Africa/Harare",
270n/a "Africa/Johannesburg",
280n/a "Africa/Juba",
290n/a "Africa/Kampala",
300n/a "Africa/Khartoum",
310n/a "Africa/Kigali",
320n/a "Africa/Kinshasa",
330n/a "Africa/Lagos",
340n/a "Africa/Libreville",
351n/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",
450n/a "Africa/Nairobi",
460n/a "Africa/Ndjamena",
470n/a "Africa/Niamey",
480n/a "Africa/Nouakchott",
490n/a "Africa/Ouagadougou",
500n/a "Africa/Porto-Novo",
514n/a "Africa/Sao_Tome",
520n/a "Africa/Timbuktu",
530n/a "Africa/Tripoli",
546n/a "Africa/Tunis",
550n/a "Africa/Windhoek",
561n/a "America/Adak",
570n/a "America/Anchorage",
580n/a "America/Anguilla",
590n/a "America/Antigua",
601n/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",
682n/a "America/Argentina/Salta",
690n/a "America/Argentina/San_Juan",
700n/a "America/Argentina/San_Luis",
710n/a "America/Argentina/Tucuman",
720n/a "America/Argentina/Ushuaia",
730n/a "America/Aruba",
740n/a "America/Asuncion",
750n/a "America/Atikokan",
761n/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",
840n/a "America/Bogota",
850n/a "America/Boise",
860n/a "America/Cambridge_Bay",
870n/a "America/Campo_Grande",
881n/a "America/Cancun",
890n/a "America/Caracas",
900n/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",
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",
1085n/a "America/Eirunepe",
1092n/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",
1153n/a "America/Grand_Turk",
1161n/a "America/Grenada",
1171n/a "America/Guadeloupe",
1181n/a "America/Guatemala",
1191n/a "America/Guayaquil",
1201n/a "America/Guyana",
1211n/a "America/Halifax",
1221n/a "America/Havana",
1231n/a "America/Hermosillo",
1241n/a "America/Indiana/Indianapolis",
1252n/a "America/Indiana/Knox",
1262n/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",
1381n/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",
1461n/a "America/Marigot",
1471n/a "America/Martinique",
1482n/a "America/Matamoros",
1492n/a "America/Mazatlan",
1501n/a "America/Menominee",
1511n/a "America/Merida",
1521n/a "America/Metlakatla",
1531n/a "America/Mexico_City",
1541n/a "America/Miquelon",
1552n/a "America/Moncton",
1561n/a "America/Monterrey",
1571n/a "America/Montevideo",
1581n/a "America/Montreal",
1591n/a "America/Montserrat",
1601n/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",
1692n/a "America/Ojinaga",
1702n/a "America/Panama",
1714n/a "America/Pangnirtung",
1721n/a "America/Paramaribo",
1732n/a "America/Phoenix",
1741n/a "America/Port-au-Prince",
1751n/a "America/Port_of_Spain",
1762n/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",
1832n/a "America/Regina",
1841n/a "America/Resolute",
1851n/a "America/Rio_Branco",
1861n/a "America/Santa_Isabel",
1871n/a "America/Santarem",
1884n/a "America/Santiago",
1895n/a "America/Santo_Domingo",
1901n/a "America/Sao_Paulo",
1911n/a "America/Scoresbysund",
1922n/a "America/Shiprock",
1932n/a "America/Sitka",
1941n/a "America/St_Barthelemy",
1951n/a "America/St_Johns",
1961n/a "America/St_Kitts",
1973n/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",
2062n/a "America/Tortola",
2071n/a "America/Vancouver",
2081n/a "America/Virgin",
2091n/a "America/Whitehorse",
2101n/a "America/Winnipeg",
2111n/a "America/Yakutat",
2122n/a "America/Yellowknife",
2131n/a "Antarctica/Casey",
2141n/a "Antarctica/Davis",
2151n/a "Antarctica/DumontDUrville",
2161n/a "Antarctica/Macquarie",
2171n/a "Antarctica/Mawson",
2181n/a "Antarctica/McMurdo",
2191n/a "Antarctica/Palmer",
2202n/a "Antarctica/Rothera",
2212n/a "Antarctica/Syowa",
2222n/a "Antarctica/Troll",
2231n/a "Antarctica/Vostok",
2241n/a "Arctic/Longyearbyen",
2251n/a "Asia/Aden",
2261n/a "Asia/Almaty",
2272n/a "Asia/Amman",
2282n/a "Asia/Anadyr",
2293n/a "Asia/Aqtau",
2303n/a "Asia/Aqtobe",
2311n/a "Asia/Ashgabat",
2321n/a "Asia/Atyrau",
2331n/a "Asia/Baghdad",
2341n/a "Asia/Bahrain",
2351n/a "Asia/Baku",
2367n/a "Asia/Bangkok",
2371n/a "Asia/Barnaul",
2381n/a "Asia/Beirut",
2391n/a "Asia/Bishkek",
2401n/a "Asia/Brunei",
2412n/a "Asia/Chita",
2421n/a "Asia/Chongqing",
2431n/a "Asia/Colombo",
2441n/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",
2515n/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",
2621n/a "Asia/Kamchatka",
2632n/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",
2741n/a "Asia/Makassar",
2752n/a "Asia/Manila",
2761n/a "Asia/Muscat",
2771n/a "Asia/Nicosia",
2781n/a "Asia/Novokuznetsk",
2791n/a "Asia/Novosibirsk",
2802n/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",
2872n/a "Asia/Qyzylorda",
2881n/a "Asia/Riyadh",
2891n/a "Asia/Sakhalin",
2902n/a "Asia/Samarkand",
2913n/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",
3082n/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",
3213n/a "Atlantic/St_Helena",
3221n/a "Atlantic/Stanley",
3231n/a "Australia/Adelaide",
3242n/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",
3391n/a "Etc/GMT+1",
3401n/a "Etc/GMT+10",
3411n/a "Etc/GMT+11",
3426n/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",
3492n/a "Etc/GMT+8",
3502n/a "Etc/GMT+9",
3514n/a "Etc/GMT-0",
3522n/a "Etc/GMT-1",
3531n/a "Etc/GMT-10",
3542n/a "Etc/GMT-11",
3551n/a "Etc/GMT-12",
3561n/a "Etc/GMT-13",
3571n/a "Etc/GMT-14",
3581n/a "Etc/GMT-2",
3592n/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",
3661n/a "Etc/GMT0",
3671n/a "Etc/Greenwich",
3681n/a "Etc/UCT",
3691n/a "Etc/UTC",
3706n/a "Etc/Universal",
3711n/a "Etc/Zulu",
3721n/a "Europe/Amsterdam",
3731n/a "Europe/Andorra",
3741n/a "Europe/Astrakhan",
3751n/a "Europe/Athens",
3761n/a "Europe/Belfast",
3771n/a "Europe/Belgrade",
3781n/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",
3892n/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",
4082n/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",
4181n/a "Europe/Skopje",
4191n/a "Europe/Sofia",
4201n/a "Europe/Stockholm",
4211n/a "Europe/Tallinn",
4221n/a "Europe/Tirane",
4231n/a "Europe/Tiraspol",
4241n/a "Europe/Ulyanovsk",
4251n/a "Europe/Vaduz",
4266n/a "Europe/Vatican",
4271n/a "Europe/Vienna",
4282n/a "Europe/Vilnius",
4291n/a "Europe/Volgograd",
4301n/a "Europe/Warsaw",
4311n/a "Europe/Zagreb",
4321n/a "Europe/Zurich",
4331n/a "Factory",
4343n/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",
4416n/a "Indian/Mahe",
4421n/a "Indian/Maldives",
4431n/a "Indian/Mauritius",
4441n/a "Indian/Mayotte",
4451n/a "Indian/Reunion",
4463n/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",
4533n/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",
4622n/a "Pacific/Kanton",
4632n/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",
4711n/a "Pacific/Norfolk",
4721n/a "Pacific/Noumea",
4731n/a "Pacific/Pago_Pago",
4741n/a "Pacific/Palau",
4752n/a "Pacific/Pitcairn",
4761n/a "Pacific/Pohnpei",
4771n/a "Pacific/Port_Moresby",
4781n/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",
4854n/a "Pacific/Wallis",
4861n/a "Pacific/Yap",
48724n/a "UTC",
4881n/a "localtime"
48958215 ],
4905943 "minLength": 1,
491597n/a "type": "string"
49258215}
interval2 / 2
TimeInterval
197636{
297636 "enum": [
3506n/a "year",
466n/a "month",
543n/a "week",
6292n/a "day",
769n/a "hour"
897636 ],
91012n/a "type": "string"
1097636}
organization_id2 / 7
110130{
210130 "anyOf": [
301013 {
400 "format": "uuid4",
50n/a "type": "string",
601013 },
710130 {
810130 "items": {
910130 "format": "uuid4",
101013n/a "type": "string",
1110130 },
1210130 "type": "array"
1310130 },
1401013 {
1501013 "type": "null"
1601013 }
1710130 ],
1810130}
product_id3 / 7
18704{
28704 "anyOf": [
30874 {
400 "format": "uuid4",
50n/a "type": "string",
60874 },
78704 {
88704 "items": {
98860 "format": "uuid4",
10886n/a "type": "string",
118704 },
128740 "type": "array"
138704 },
140874 {
150874 "type": "null"
160874 }
178704 ],
188704}
billing_type4 / 7
151018{
251018 "anyOf": [
30528 {
40528 "$ref": "#/components/schemas/ProductBillingType"
50528 },
651018 {
751018 "items": {
860820 "$ref": "#/components/schemas/ProductBillingType"
951018 },
105280 "type": "array"
1151018 },
120528 {
130528 "type": "null"
140528 }
1551018 ],
1651018}
Referenced Components (1)3 of 3 keywords
ProductBillingType3 of 3 keywords
1608548{
2608548 "enum": [
3524n/a "one_time",
484n/a "recurring"
5608548 ],
6610n/a "type": "string"
7608548}
customer_id3 / 7
15444{
25444 "anyOf": [
30548 {
400 "format": "uuid4",
50n/a "type": "string"
60548 },
75444 {
85444 "items": {
97360 "format": "uuid4",
10736n/a "type": "string"
115444 },
125480 "type": "array"
135444 },
140548 {
150548 "type": "null"
160548 }
175444 ],
185444}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response66321ms
422Validation Error2215ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized392ms
500Internal Server Error90909ms
Examples1 / 3 used
Query
"UTC"timezone
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
Responses1 of 1 documented received
codedescriptionhitsavg
200Successful Response1154ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1902ms
notifications 5 operations 3 covered 2 partial 0 uncovered 0 not measured 92% #
Responses1 of 1 documented received
codedescriptionhitsavg
200Successful Response1345ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1702ms
Body4 of 5 keywords covered
application/json4 / 5
NotificationsMarkRead
#validinvalidschema
123314{
22335 "properties": {
32335 "notification_id": {
42330 "format": "uuid4",
52335 "type": "string"
62335 }
72335 },
82383 "required": [
92383 "notification_id"
102383 ],
112416 "type": "object"
1223314}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response21439ms
422Validation Error304ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized192ms
Query Parameters12 of 12 keywords covered
expo_push_token3 / 3
#validinvalidschema
1224n/a{
2224n/a "anyOf": [
3209n/a {
4209n/a "type": "string"
5209n/a },
615209 {
715209 "type": "null"
815209 }
9224n/a ],
10224n/a}
platform5 / 5
110042{
210042 "anyOf": [
38953 {
48953 "$ref": "#/components/schemas/NotificationRecipientPlatform"
58953 },
611131 {
711131 "type": "null"
811131 }
910042 ],
1010042}
Referenced Components (1)3 of 3 keywords
NotificationRecipientPlatform3 of 3 keywords
18953{
28953 "enum": [
354n/a "ios",
435n/a "android"
58953 ],
6131n/a "type": "string"
78953}
page2 / 2
119526{
21956 "exclusiveMinimum": 0,
320120 "type": "integer"
419526}
limit2 / 2
121619{
22162 "exclusiveMinimum": 0,
321817 "type": "integer"
421619}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response4316ms
422Validation Error745ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1072ms
Examples2 / 2 used
Query
1page
10limit
Body7 of 7 keywords covered
application/json7 / 7
NotificationRecipientCreate
#validinvalidschema
142233{
243315 "properties": {
34375 "expo_push_token": {
44375 "type": "string"
54375 },
643310 "platform": {
743310 "$ref": "#/components/schemas/NotificationRecipientPlatform",
843310 }
943315 },
1043713 "required": [
114437 "platform",
124428 "expo_push_token"
1343713 ],
144505 "type": "object"
1542233}
Referenced Components (1)3 of 3 keywords
NotificationRecipientPlatform3 of 3 keywords
143310{
243310 "enum": [
3257n/a "ios",
4176n/a "android"
543310 ],
64385 "type": "string"
743310}
Responses2 of 2 documented received
codedescriptionhitsavg
201Device subscribed to notifications.7613ms
422Validation Error3296ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized602ms
400Bad Request34ms
500Internal Server Error31353ms
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
1410{
2410 "format": "uuid4",
341n/a "type": "string"
4410}
Responses1 of 3 documented received
codedescriptionhitsavg
204Notification recipient unsubscribed from notifications.358ms
404Notification recipient not found.0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized63ms
oauth2 11 operations 9 covered 1 partial 1 uncovered 0 not measured 85% #
Query Parameters4 of 4 keywords covered
page2 / 2
#validinvalidschema
116846{
21688 "exclusiveMinimum": 0,
317638 "type": "integer"
416846}
limit2 / 2
116645{
216614 "exclusiveMinimum": 0,
318031 "type": "integer"
416645}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response3577ms
422Validation Error595ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized412ms
500Internal Server Error40970ms
Examples2 / 2 used
Query
1page
10limit
Responses0 of 1 documented received
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3024ms
Body5 of 5 keywords covered
application/x-www-form-urlencoded5 / 5
Body_oauth2_consent
#validinvalidschema
126137{
226133 "properties": {
326133 "action": {
426133 "enum": [
5103n/a "allow",
6158n/a "deny"
726133 ],
8294n/a "type": "string"
926133 }
1026133 },
112944 "required": [
122944 "action"
132944 ],
14298n/a "type": "object"
1526137}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error455ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1626ms
401Unauthorized1002ms
Body10 of 10 keywords covered
application/x-www-form-urlencoded10 / 10
IntrospectTokenRequest
#validinvalidschema
1207101{
23017 "properties": {
3302n/a "client_id": {
4302n/a "type": "string"
5302n/a },
6307n/a "client_secret": {
7307n/a "type": "string"
8307n/a },
9221n/a "token": {
10221n/a "type": "string"
11221n/a },
121007 "token_type_hint": {
131007 "anyOf": [
146740 {
156740 "enum": [
1635n/a "access_token",
1732n/a "refresh_token"
186740 ],
1974n/a "type": "string"
206740 },
213374 {
223374 "type": "null"
233374 }
241007 ],
251007 }
263017 },
2721494 "required": [
2822187 "token",
293026 "client_id",
303071 "client_secret"
3121494 ],
32308n/a "type": "object"
33207101}
Responses0 of 1 documented received
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3143ms
Examples1 / 1 used
Body: application/x-www-form-urlencoded
nullIntrospectTokenRequest.token_type_hint
Body41 of 41 keywords covered
application/json41 / 41
OAuth2ClientConfiguration
#validinvalidschema
1539127{
2544117 "properties": {
36555 "client_name": {
46555 "type": "string"
56555 },
624023 "client_uri": {
724023 "anyOf": [
891172 {
991172 "type": "string"
1091172 },
11149114 {
12149114 "type": "null"
13149114 }
1424023 ],
1524023 },
162496 "default_sub_type": {
172496 "$ref": "#/components/schemas/SubType",
182496 },
1923414 "grant_types": {
202346 "items": {
216786 "enum": [
22324n/a "authorization_code",
23354n/a "refresh_token"
246786 ],
256795 "type": "string"
262346 },
272408 "type": "array"
2823414 },
2922715 "logo_uri": {
3022715 "anyOf": [
3120933 {
3221010 "format": "uri",
332128 "maxLength": 2083,
342191 "minLength": 1,
3522022 "type": "string"
3620933 },
3718224 {
3818224 "type": "null"
3918224 }
4022715 ],
4122715 },
4222820 "policy_uri": {
4322820 "anyOf": [
4420840 {
452093 "format": "uri",
462111 "maxLength": 2083,
472111 "minLength": 1,
4821236 "type": "string"
4920840 },
5020228 {
5120228 "type": "null"
5220228 }
5322820 ],
5422820 },
5564116 "redirect_uris": {
5664110 "items": {
577722 "format": "uri",
587731 "minLength": 1,
5977426 "type": "string"
6064110 },
616516 "type": "array"
6264116 },
6319014 "response_types": {
641906 "items": {
654676 "const": "code",
664685 "type": "string"
671906 },
681968 "type": "array"
6919014 },
702099 "scope": {
712099 "type": "string"
722099 },
732086 "token_endpoint_auth_method": {
742086 "enum": [
7546n/a "client_secret_basic",
76129n/a "client_secret_post",
7733n/a "none"
782086 ],
792095 "type": "string"
802086 },
8118120 "tos_uri": {
8218120 "anyOf": [
8316833 {
8416910 "format": "uri",
851718 "maxLength": 2083,
861781 "minLength": 1,
8717922 "type": "string"
8816833 },
8913188 {
9013188 "type": "null"
9113188 }
9218120 ],
9318120 }
94544117 },
956565 "required": [
966574 "redirect_uris",
976601 "client_name"
986565 ],
996615 "type": "object"
100539127}
Referenced Components (1)3 of 3 keywords
SubType3 of 3 keywords
12496{
22496 "enum": [
371n/a "user",
4178n/a "organization"
52496 ],
62505 "type": "string"
72496}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error1435ms
Undocumented - not in spec
codedescriptionhitsavg
201Created5195ms
400Bad Request244ms
Examples5 / 5 used
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 Parameters1 of 1 keywords covered
client_id1 / 1
#validinvalidschema
1105n/a{
2105n/a "type": "string"
3105n/a}
Responses0 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized57ms
204No Content506ms
400Bad Request502ms
Path Parameters1 of 1 keywords covered
client_id1 / 1
#validinvalidschema
1573n/a{
2573n/a "type": "string"
3573n/a}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response2656ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized135ms
400Bad Request2952ms
Path Parameters1 of 1 keywords covered
client_id1 / 1
#validinvalidschema
1533n/a{
2533n/a "type": "string"
3533n/a}
Body42 of 42 keywords covered
application/json42 / 42
OAuth2ClientConfigurationUpdate
1358112{
237491 "properties": {
34595 "client_id": {
44595 "type": "string"
54595 },
64595 "client_name": {
74595 "type": "string"
84595 },
91724 "client_uri": {
101724 "anyOf": [
1151125 {
1251125 "type": "string"
1351125 },
1412155 {
1512155 "type": "null"
1612155 }
171724 ],
181724 },
191586 "default_sub_type": {
201586 "$ref": "#/components/schemas/SubType",
211586 },
2215011 "grant_types": {
231506 "items": {
243286 "enum": [
25160n/a "authorization_code",
26168n/a "refresh_token"
273286 ],
283295 "type": "string"
291506 },
301565 "type": "array"
3115011 },
321598 "logo_uri": {
331598 "anyOf": [
3414720 {
351483 "format": "uri",
361501 "maxLength": 2083,
371501 "minLength": 1,
3815116 "type": "string"
3914720 },
4012155 {
4112155 "type": "null"
4212155 }
431598 ],
441598 },
451548 "policy_uri": {
461548 "anyOf": [
4713923 {
481403 "format": "uri",
491421 "maxLength": 2083,
501421 "minLength": 1,
5114319 "type": "string"
5213923 },
5315147 {
5415147 "type": "null"
5515147 }
561548 ],
571548 },
5843714 "redirect_uris": {
594379 "items": {
604854 "format": "uri",
614863 "minLength": 1,
624895 "type": "string"
634379 },
644465 "type": "array"
6543714 },
6615711 "response_types": {
671576 "items": {
683326 "const": "code",
693335 "type": "string"
701576 },
711635 "type": "array"
7215711 },
731545 "scope": {
741545 "type": "string"
751545 },
761426 "token_endpoint_auth_method": {
771426 "enum": [
7811n/a "client_secret_basic",
79126n/a "client_secret_post",
805n/a "none"
811426 ],
821435 "type": "string"
831426 },
841418 "tos_uri": {
851418 "anyOf": [
8612623 {
871273 "format": "uri",
881291 "maxLength": 2083,
891291 "minLength": 1,
9013019 "type": "string"
9112623 },
9215134 {
9315134 "type": "null"
9415134 }
951418 ],
961418 }
9737491 },
9844916 "required": [
9945114 "redirect_uris",
1004641 "client_name",
1014641 "client_id"
10244916 ],
1034655 "type": "object"
104358112}
Referenced Components (1)3 of 3 keywords
SubType3 of 3 keywords
11586{
21586 "enum": [
322n/a "user",
4136n/a "organization"
51586 ],
61595 "type": "string"
71586}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response956ms
422Validation Error1425ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized566ms
400Bad Request2404ms
Examples5 / 5 used
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
Bodynot covered
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 Responses0 of 1 documented received
codedescriptionhitsavg
200Successful Response0never seen
Body28 of 41 keywords covered
application/x-www-form-urlencoded28 / 41
#validinvalidschema
128046{
228046 "oneOf": [
376250 {
476250 "$ref": "#/components/schemas/AuthorizationCodeTokenRequest"
576250 },
6160166 {
7160166 "$ref": "#/components/schemas/RefreshTokenRequest"
8160166 },
944282 {
1044282 "$ref": "#/components/schemas/WebTokenRequest"
1144282 }
1228046 ]
1328046}
Referenced Components (3)32 of 46 keywords
AuthorizationCodeTokenRequest10 of 14 keywords
176250{
284236 "properties": {
33100 "client_id": {
43100 "type": "string"
53100 },
63161 "client_secret": {
73161 "type": "string"
83161 },
9910 "code": {
10910 "type": "string"
11910 },
1290227 "grant_type": {
1390227 "const": "authorization_code",
143170 "type": "string"
1590227 },
16838 "redirect_uri": {
17846 "format": "uri",
18855 "maxLength": 2083,
19882 "minLength": 1,
20901 "type": "string"
21838 }
2284236 },
2386240 "required": [
243179 "grant_type",
2531016 "client_id",
263179 "client_secret",
2791235 "code",
2891235 "redirect_uri"
2986240 ],
303260 "type": "object"
3176250}
RefreshTokenRequest6 of 10 keywords
1160166{
2168152 "properties": {
33100 "client_id": {
43100 "type": "string"
53100 },
63161 "client_secret": {
73161 "type": "string"
83161 },
9165152 "grant_type": {
10165152 "const": "refresh_token",
113170 "type": "string"
12165152 },
131640 "refresh_token": {
141640 "type": "string"
151640 }
16168152 },
17161165 "required": [
183179 "grant_type",
1931016 "client_id",
203179 "client_secret",
21164162 "refresh_token"
22161165 ],
233260 "type": "object"
24160166}
WebTokenRequest16 of 22 keywords
144282{
256264 "properties": {
33100 "client_id": {
43100 "type": "string"
53100 },
63161 "client_secret": {
73161 "type": "string"
83161 },
959258 "grant_type": {
1059258 "const": "web",
113170 "type": "string"
1259258 },
13240 "scope": {
14240 "anyOf": [
15123 {
16123 "type": "string"
17123 },
18231 {
19231 "type": "null"
20231 }
21240 ],
22240 },
23591 "session_token": {
24591 "type": "string"
25591 },
26154 "sub": {
27154 "anyOf": [
28316 {
2934 "format": "uuid4",
30712 "type": "string"
31316 },
32127 {
33127 "type": "null"
34127 }
35154 ],
36154 },
37162 "sub_type": {
38162 "enum": [
3913n/a "user",
403n/a "organization"
41162 ],
42180 "type": "string"
43162 }
4456264 },
4551275 "required": [
463179 "grant_type",
4731016 "client_id",
483179 "client_secret",
4960266 "session_token"
5051275 ],
513260 "type": "object"
5244282}
Responses0 of 1 documented received
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3362ms
Examples3 / 3 used
Body: application/x-www-form-urlencoded
nullWebTokenRequest.scope
nullWebTokenRequest.sub
"user"WebTokenRequest.sub_type
Responses0 of 1 documented received
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized52ms
orders 6 operations 1 covered 5 partial 0 uncovered 0 not measured 55% #
Query Parameters32 of 65 keywords covered
organization_id2 / 7
#validinvalidschema
19040{
29040 "anyOf": [
30904 {
400 "format": "uuid4",
50n/a "type": "string",
60904 },
79040 {
89040 "items": {
99040 "format": "uuid4",
10904n/a "type": "string",
119040 },
129040 "type": "array"
139040 },
140904 {
150904 "type": "null"
160904 }
179040 ],
189040}
product_id3 / 7
17714{
27714 "anyOf": [
30775 {
400 "format": "uuid4",
50n/a "type": "string",
60775 },
77714 {
87714 "items": {
98610 "format": "uuid4",
10861n/a "type": "string",
117714 },
127750 "type": "array"
137714 },
140775 {
150775 "type": "null"
160775 }
177714 ],
187714}
product_billing_type4 / 7
127613{
227613 "anyOf": [
30289 {
40289 "$ref": "#/components/schemas/ProductBillingType"
50289 },
627613 {
727613 "items": {
862815 "$ref": "#/components/schemas/ProductBillingType"
927613 },
102890 "type": "array"
1127613 },
120289 {
130289 "type": "null"
140289 }
1527613 ],
1627613}
Referenced Components (1)3 of 3 keywords
ProductBillingType3 of 3 keywords
1628304{
2628304 "enum": [
3348n/a "one_time",
4280n/a "recurring"
5628304 ],
6630n/a "type": "string"
7628304}
discount_id4 / 7
12706{
22706 "anyOf": [
30276 {
400 "format": "uuid4",
50n/a "type": "string"
60276 },
72706 {
82706 "items": {
961811 "format": "uuid4",
10629n/a "type": "string"
112706 },
122760 "type": "array"
132706 },
140276 {
150276 "type": "null"
160276 }
172706 ],
182706}
customer_id3 / 7
12694{
22694 "anyOf": [
30273 {
400 "format": "uuid4",
50n/a "type": "string"
60273 },
72694 {
82694 "items": {
97390 "format": "uuid4",
10739n/a "type": "string"
112694 },
122730 "type": "array"
132694 },
140273 {
150273 "type": "null"
160273 }
172694 ],
182694}
checkout_id4 / 7
17765{
27765 "anyOf": [
30781 {
400 "format": "uuid4",
50n/a "type": "string"
60781 },
77765 {
87765 "items": {
98681 "format": "uuid4",
10869n/a "type": "string"
117765 },
127810 "type": "array"
137765 },
140781 {
150781 "type": "null"
160781 }
177765 ],
187765}
page2 / 2
136526{
23652 "exclusiveMinimum": 0,
336724 "type": "integer"
436526}
limit2 / 2
137524{
23752 "exclusiveMinimum": 0,
337722 "type": "integer"
437524}
sorting4 / 6
119512{
219512 "anyOf": [
319512 {
419512 "items": {
598114 "$ref": "#/components/schemas/OrderSortProperty"
619512 },
72070 "type": "array"
819512 },
90207 {
100207 "type": "null"
110207 }
1219512 ],
1319512}
Referenced Components (1)3 of 3 keywords
OrderSortProperty3 of 3 keywords
198114{
298114 "enum": [
353n/a "created_at",
4111n/a "-created_at",
566n/a "status",
668n/a "-status",
751n/a "invoice_number",
845n/a "-invoice_number",
968n/a "amount",
1052n/a "-amount",
1127n/a "net_amount",
1245n/a "-net_amount",
1338n/a "customer",
1453n/a "-customer",
1548n/a "product",
1635n/a "-product",
1775n/a "discount",
1871n/a "-discount",
1931n/a "subscription",
2044n/a "-subscription"
2198114 ],
22983n/a "type": "string"
2398114}
metadata4 / 13
MetadataQuery
11220{
21220 "anyOf": [
31220 {
41220 "additionalProperties": {
53360 "anyOf": [
6221115 {
7221115 "type": "string"
8221115 },
90336 {
100336 "type": "integer"
110336 },
120336 {
130336 "type": "boolean"
140336 },
15115221 {
161150 "items": {
176140 "type": "string"
181150 },
19115221 "type": "array"
20115221 },
210336 {
220115 "items": {
230614 "type": "integer"
240115 },
25115221 "type": "array"
260336 },
270336 {
280115 "items": {
290614 "type": "boolean"
300115 },
31115221 "type": "array"
320336 }
333360 ]
341220 },
351220 "type": "object"
361220 },
370122 {
380122 "type": "null"
390122 }
401220 ],
411220}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response69711ms
422Validation Error675ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1162ms
500Internal Server Error241550ms
Examples3 / 5 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-created_at" ]sorting
Query Parameters5 of 14 keywords covered
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}
product_id3 / 7
14474{
24474 "anyOf": [
30451 {
400 "format": "uuid4",
50n/a "type": "string",
60451 },
74474 {
84474 "items": {
94560 "format": "uuid4",
10456n/a "type": "string",
114474 },
124510 "type": "array"
134474 },
140451 {
150451 "type": "null"
160451 }
174474 ],
184474}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response4046ms
422Validation Error45ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1032ms
Examples0 / 2 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13200{
23200 "format": "uuid4",
3320n/a "type": "string"
43200}
Responses1 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Order not found.2856ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized352ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
16342{
26342 "format": "uuid4",
3636n/a "type": "string"
46342}
Body29 of 29 keywords covered
application/json29 / 29
OrderUpdate
153152{
253444 "properties": {
353740 "billing_address": {
453740 "anyOf": [
5343234 {
6343234 "$ref": "#/components/schemas/AddressInput"
7343234 },
8194383 {
9194383 "type": "null"
10194383 }
1153740 ],
1253740 },
135724 "billing_name": {
145724 "anyOf": [
15250326 {
16250326 "type": "string"
17250326 },
18322254 {
19322254 "type": "null"
20322254 }
215724 ],
225724 }
2353444 },
245753 "required": [
255762 "billing_name",
265771 "billing_address"
275753 ],
285785 "type": "object"
2953152}
Referenced Components (1)28 of 28 keywords
AddressInput28 of 28 keywords
1343234{
234434 "properties": {
330210 "city": {
430210 "anyOf": [
512300 {
612300 "type": "string"
712300 },
829022 {
929022 "type": "null"
1029022 }
1130210 ],
1230210 },
133716 "country": {
143716 "enum": [
1522n/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",
281n/a "AW",
291n/a "AX",
301n/a "AZ",
311n/a "BA",
328n/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",
712n/a "DJ",
721n/a "DK",
731n/a "DM",
741n/a "DO",
751n/a "DZ",
761n/a "EC",
777n/a "EE",
781n/a "EG",
793n/a "EH",
808n/a "ER",
812n/a "ES",
821n/a "ET",
831n/a "FI",
841n/a "FJ",
851n/a "FK",
863n/a "FM",
872n/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",
987n/a "GM",
991n/a "GN",
1001n/a "GP",
1012n/a "GQ",
1021n/a "GR",
1031n/a "GS",
1041n/a "GT",
1051n/a "GU",
1061n/a "GW",
1073n/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",
1182n/a "IN",
1191n/a "IO",
1201n/a "IQ",
1211n/a "IS",
1223n/a "IT",
1232n/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",
1362n/a "KZ",
1371n/a "LA",
1381n/a "LB",
1391n/a "LC",
1401n/a "LI",
1413n/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",
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",
1614n/a "MQ",
1622n/a "MR",
1631n/a "MS",
1641n/a "MT",
1655n/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",
1832n/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",
1927n/a "PN",
1932n/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",
2093n/a "SH",
2101n/a "SI",
2111n/a "SJ",
2121n/a "SK",
2131n/a "SL",
2141n/a "SM",
2151n/a "SN",
2161n/a "SO",
2175n/a "SR",
2181n/a "SS",
2191n/a "ST",
2201n/a "SV",
2212n/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",
2441n/a "UZ",
2451n/a "VA",
2461n/a "VC",
2471n/a "VE",
2481n/a "VG",
2491n/a "VI",
2501n/a "VN",
2512n/a "VU",
2521n/a "WF",
2531n/a "WS",
2541n/a "YE",
2552n/a "YT",
2561n/a "ZA",
2571n/a "ZM",
2581n/a "ZW"
2593716 ],
2603725 "type": "string",
2613716 },
2623124 "line1": {
2633124 "anyOf": [
26413303 {
26513303 "type": "string"
26613303 },
26729917 {
26829917 "type": "null"
26929917 }
2703124 ],
2713124 },
2723104 "line2": {
2733104 "anyOf": [
27422292 {
27522292 "type": "string"
27622292 },
27728826 {
27828826 "type": "null"
27928826 }
2803104 ],
2813104 },
2823164 "postal_code": {
2833164 "anyOf": [
28418302 {
28518302 "type": "string"
28618302 },
28729822 {
28829822 "type": "null"
28929822 }
2903164 ],
2913164 },
29229712 "state": {
29329712 "anyOf": [
29418291 {
29518291 "type": "string"
29618291 },
29727930 {
29827930 "type": "null"
29927930 }
30029712 ],
30129712 }
30234434 },
3033772 "required": [
3043772 "country"
3053772 ],
306379198 "type": "object"
307343234}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Order not found.5167ms
422Validation Error735ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error5797ms
400Bad Request295ms
401Unauthorized132ms
Examples3 / 3 used
Body: application/json
"US"AddressInput.country.examples[0]
"SE"AddressInput.country.examples[1]
"FR"AddressInput.country.examples[2]
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13200{
23200 "format": "uuid4",
3320n/a "type": "string"
43200}
Responses1 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Order not found.2926ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized282ms
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13260{
23260 "format": "uuid4",
3326n/a "type": "string"
43260}
Responses0 of 2 documented received
codedescriptionhitsavg
202Successful Response0never seen
422Order is not paid or is missing billing name or address.0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3137ms
401Unauthorized132ms
organization_access_token 4 operations 1 covered 3 partial 0 uncovered 0 not measured 78% #
Query Parameters10 of 17 keywords covered
organization_id2 / 7
#validinvalidschema
17140{
27140 "anyOf": [
30714 {
400 "format": "uuid4",
50n/a "type": "string",
60714 },
77140 {
87140 "items": {
97140 "format": "uuid4",
10714n/a "type": "string",
117140 },
127140 "type": "array"
137140 },
140714 {
150714 "type": "null"
160714 }
177140 ],
187140}
page2 / 2
124649{
224610 "exclusiveMinimum": 0,
325639 "type": "integer"
424649}
limit2 / 2
128540{
228510 "exclusiveMinimum": 0,
329530 "type": "integer"
428540}
sorting4 / 6
113040{
213040 "anyOf": [
313040 {
413040 "items": {
5743100 "$ref": "#/components/schemas/OrganizationAccessTokenSortProperty"
613040 },
71700 "type": "array"
813040 },
90170 {
100170 "type": "null"
110170 }
1213040 ],
1313040}
Referenced Components (1)3 of 3 keywords
OrganizationAccessTokenSortProperty3 of 3 keywords
1743100{
2743100 "enum": [
3125n/a "created_at",
488n/a "-created_at",
569n/a "comment",
681n/a "-comment",
786n/a "last_used_at",
8121n/a "-last_used_at",
989n/a "organization_id",
1084n/a "-organization_id"
11743100 ],
12799n/a "type": "string"
13743100}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response5548ms
422Validation Error745ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized752ms
500Internal Server Error111463ms
Examples3 / 5 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "created_at" ]sorting
Body13 of 14 keywords covered
application/json13 / 14
OrganizationAccessTokenCreate
#validinvalidschema
151856{
252940 "properties": {
355312 "comment": {
455312 "type": "string"
555312 },
62397 "expires_in": {
72397 "anyOf": [
822521 {
92252 "format": "duration",
1022719 "type": "string"
1122521 },
1214232 {
1314232 "type": "null"
1414232 }
152397 ],
162397 },
175635 "organization_id": {
185630 "format": "uuid4",
195635 "type": "string"
205635 },
2154317 "scopes": {
2254312 "items": {
23149916 "$ref": "#/components/schemas/AvailableScope"
2454312 },
255555 "type": "array"
2654317 }
2752940 },
2855811 "required": [
295681 "organization_id",
305654 "comment",
315609 "scopes"
3255811 ],
335695 "type": "object"
3451856}
Referenced Components (1)3 of 3 keywords
AvailableScope3 of 3 keywords
1149916{
2149916 "enum": [
342n/a "openid",
432n/a "profile",
529n/a "email",
628n/a "user:read",
719n/a "organizations:read",
827n/a "organizations:write",
911n/a "custom_fields:read",
1034n/a "custom_fields:write",
1124n/a "discounts:read",
1234n/a "discounts:write",
1317n/a "checkout_links:read",
1424n/a "checkout_links:write",
1539n/a "checkouts:read",
1614n/a "checkouts:write",
1714n/a "transactions:read",
1824n/a "transactions:write",
1915n/a "payouts:read",
2024n/a "payouts:write",
2121n/a "products:read",
2220n/a "products:write",
2329n/a "benefits:read",
2413n/a "benefits:write",
2516n/a "events:read",
2616n/a "events:write",
2722n/a "meters:read",
2818n/a "meters:write",
2920n/a "files:read",
3019n/a "files:write",
3128n/a "subscriptions:read",
3232n/a "subscriptions:write",
3330n/a "customers:read",
3428n/a "customers:write",
3528n/a "members:read",
3623n/a "members:write",
3718n/a "wallets:read",
3818n/a "wallets:write",
3940n/a "customer_meters:read",
4030n/a "customer_sessions:write",
4128n/a "customer_seats:read",
4228n/a "customer_seats:write",
4323n/a "orders:read",
4416n/a "orders:write",
4524n/a "refunds:read",
4619n/a "refunds:write",
4723n/a "payments:read",
4836n/a "metrics:read",
4932n/a "webhooks:read",
5019n/a "webhooks:write",
5127n/a "external_organizations:read",
5217n/a "license_keys:read",
5318n/a "license_keys:write",
5437n/a "repositories:read",
5515n/a "repositories:write",
5625n/a "issues:read",
5730n/a "issues:write",
5829n/a "customer_portal:read",
5938n/a "customer_portal:write",
6030n/a "notifications:read",
6115n/a "notifications:write",
6226n/a "notification_recipients:read",
6324n/a "notification_recipients:write"
64149916 ],
6515105 "type": "string"
66149916}
Responses2 of 2 documented received
codedescriptionhitsavg
201Successful Response43011ms
422Validation Error1356ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized242ms
400Bad Request85ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
1551{
2551 "format": "uuid4",
356n/a "type": "string"
4551}
Responses2 of 2 documented received
codedescriptionhitsavg
204Successful Response4110ms
422Validation Error16ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found86ms
401Unauthorized62ms
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13220{
23220 "format": "uuid4",
3322n/a "type": "string"
43220}
Body11 of 11 keywords covered
application/json11 / 11
OrganizationAccessTokenUpdate
127826{
211519 "properties": {
31204 "comment": {
41204 "anyOf": [
53292 {
63292 "type": "string"
73292 },
88836 {
98836 "type": "null"
108836 }
111204 ],
121204 },
1310815 "scopes": {
1410815 "anyOf": [
158736 {
16877 "items": {
171288 "$ref": "#/components/schemas/AvailableScope"
18877 },
199429 "type": "array"
208736 },
2121102 {
2221102 "type": "null"
2321102 }
2410815 ],
2510815 }
2611519 },
272977 "type": "object"
2827826}
Referenced Components (1)3 of 3 keywords
AvailableScope3 of 3 keywords
11288{
21288 "enum": [
31n/a "openid",
45n/a "profile",
51n/a "email",
61n/a "user:read",
71n/a "organizations:read",
88n/a "organizations:write",
98n/a "custom_fields:read",
104n/a "custom_fields:write",
112n/a "discounts:read",
122n/a "discounts:write",
131n/a "checkout_links:read",
142n/a "checkout_links:write",
151n/a "checkouts:read",
166n/a "checkouts:write",
172n/a "transactions:read",
181n/a "transactions:write",
192n/a "payouts:read",
201n/a "payouts:write",
211n/a "products:read",
221n/a "products:write",
231n/a "benefits:read",
241n/a "benefits:write",
252n/a "events:read",
261n/a "events:write",
271n/a "meters:read",
281n/a "meters:write",
291n/a "files:read",
301n/a "files:write",
312n/a "subscriptions:read",
326n/a "subscriptions:write",
331n/a "customers:read",
341n/a "customers:write",
352n/a "members:read",
361n/a "members:write",
371n/a "wallets:read",
381n/a "wallets:write",
392n/a "customer_meters:read",
402n/a "customer_sessions:write",
411n/a "customer_seats:read",
421n/a "customer_seats:write",
434n/a "orders:read",
448n/a "orders:write",
455n/a "refunds:read",
461n/a "refunds:write",
472n/a "payments:read",
481n/a "metrics:read",
491n/a "webhooks:read",
502n/a "webhooks:write",
512n/a "external_organizations:read",
521n/a "license_keys:read",
531n/a "license_keys:write",
541n/a "repositories:read",
551n/a "repositories:write",
561n/a "issues:read",
5710n/a "issues:write",
581n/a "customer_portal:read",
591n/a "customer_portal:write",
601n/a "notifications:read",
611n/a "notifications:write",
621n/a "notification_recipients:read",
631n/a "notification_recipients:write"
641288 ],
651297 "type": "string"
661288}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response1727ms
422Validation Error365ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found816ms
401Unauthorized143ms
500Internal Server Error111804ms
400Bad Request85ms
organizations 12 operations 1 covered 10 partial 1 uncovered 0 not measured 89% #
Query Parameters11 of 13 keywords covered
slug3 / 3
#validinvalidschema
1156n/a{
2156n/a "anyOf": [
3149n/a {
4149n/a "type": "string"
5149n/a },
67149 {
77149 "type": "null"
87149 }
9156n/a ],
10156n/a}
page2 / 2
117434{
21746 "exclusiveMinimum": 0,
318028 "type": "integer"
417434}
limit2 / 2
121043{
221011 "exclusiveMinimum": 0,
322132 "type": "integer"
421043}
sorting4 / 6
18730{
28730 "anyOf": [
38730 {
48730 "items": {
535666 "$ref": "#/components/schemas/OrganizationSortProperty"
68730 },
71170 "type": "array"
88730 },
90117 {
100117 "type": "null"
110117 }
128730 ],
138730}
Referenced Components (1)3 of 3 keywords
OrganizationSortProperty3 of 3 keywords
135666{
235666 "enum": [
347n/a "created_at",
424n/a "-created_at",
522n/a "slug",
654n/a "-slug",
734n/a "name",
821n/a "-name",
940n/a "next_review_threshold",
1044n/a "-next_review_threshold",
1147n/a "days_in_status",
1223n/a "-days_in_status"
1335666 ],
14401n/a "type": "string"
1535666}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response3657ms
422Validation Error635ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized572ms
500Internal Server Error131530ms
Examples3 / 3 used
Query
1page
10limit
[ "created_at" ]sorting
Body87 of 102 keywords covered
application/json87 / 102
OrganizationCreate
#validinvalidschema
1446249{
2448240 "properties": {
34345 "avatar_url": {
44345 "anyOf": [
540138 {
64014 "format": "uri",
74050 "maxLength": 2083,
84014 "minLength": 1,
940534 "type": "string"
1040138 },
1133406 {
1233406 "type": "null"
1333406 }
144345 ],
154345 },
1630960 "customer_email_settings": {
1730960 "anyOf": [
1881288 {
1981288 "$ref": "#/components/schemas/OrganizationCustomerEmailSettings"
2081288 },
21228141 {
22228141 "type": "null"
23228141 }
2430960 ]
2530960 },
2629864 "details": {
2729864 "anyOf": [
2871291 {
2971291 "$ref": "#/components/schemas/OrganizationDetails"
3071291 },
31227135 {
32227135 "type": "null"
33227135 }
3429864 ],
3529864 },
363435 "email": {
373435 "anyOf": [
3830543 {
393480 "format": "email",
4030543 "type": "string"
4130543 },
4238310 {
4338310 "type": "null"
4438310 }
453435 ],
463435 },
4733338 "feature_settings": {
4833338 "anyOf": [
4982289 {
5082289 "$ref": "#/components/schemas/OrganizationFeatureSettings"
5182289 },
52251120 {
53251120 "type": "null"
54251120 }
5533338 ]
5633338 },
5767710 "name": {
5867710 "minLength": 3,
596870 "type": "string"
6067710 },
6138217 "notification_settings": {
6238217 "anyOf": [
6387312 {
6487312 "$ref": "#/components/schemas/OrganizationNotificationSettings"
6587312 },
66295104 {
67295104 "type": "null"
68295104 }
6938217 ]
7038217 },
716825 "slug": {
726825 "minLength": 3,
736870 "type": "string"
746825 },
7532417 "socials": {
7632417 "anyOf": [
7726972 {
782698 "items": {
793369 "$ref": "#/components/schemas/OrganizationSocialLink"
802698 },
8127764 "type": "array"
8226972 },
8355286 {
8455286 "type": "null"
8555286 }
8632417 ],
8732417 },
8835637 "subscription_settings": {
8935637 "anyOf": [
9068325 {
9168325 "$ref": "#/components/schemas/OrganizationSubscriptionSettings"
9268325 },
93288105 {
94288105 "type": "null"
95288105 }
9635637 ]
9735637 },
983415 "website": {
993415 "anyOf": [
10031432 {
1013140 "format": "uri",
1023140 "maxLength": 2083,
1033140 "minLength": 1,
10431432 "type": "string"
10531432 },
10627319 {
10727319 "type": "null"
10827319 }
1093415 ],
1103415 }
111448240 },
1126864 "required": [
1136873 "name",
1146873 "slug"
1156864 ],
1166905 "type": "object"
117446249}
Referenced Components (8)65 of 75 keywords
OrganizationCustomerEmailSettings13 of 13 keywords
181288{
28942 "properties": {
31255 "order_confirmation": {
41255 "type": "boolean"
51255 },
61255 "subscription_cancellation": {
71255 "type": "boolean"
81255 },
91255 "subscription_confirmation": {
101255 "type": "boolean"
111255 },
121255 "subscription_cycled": {
131255 "type": "boolean"
141255 },
151255 "subscription_past_due": {
161255 "type": "boolean"
171255 },
181255 "subscription_revoked": {
191255 "type": "boolean"
201255 },
211255 "subscription_uncanceled": {
221255 "type": "boolean"
231255 },
241237 "subscription_updated": {
251237 "type": "boolean"
261237 }
278942 },
281239 "required": [
291302 "order_confirmation",
301302 "subscription_cancellation",
311302 "subscription_confirmation",
321302 "subscription_cycled",
331302 "subscription_past_due",
341302 "subscription_revoked",
351302 "subscription_uncanceled",
361302 "subscription_updated"
371239 ],
38132237 "type": "object"
3981288}
OrganizationDetails21 of 21 keywords
171291{
27650 "properties": {
31205 "about": {
41205 "type": "string"
51205 },
611510 "customer_acquisition": {
71155 "items": {
83375 "type": "string"
91155 },
101205 "type": "array"
1111510 },
121187 "future_annual_revenue": {
131191 "minimum": 0.0,
141196 "type": "integer"
151187 },
161205 "intended_use": {
171205 "type": "string"
181205 },
19887 "previous_annual_revenue": {
20891 "minimum": 0.0,
21896 "type": "integer"
22887 },
231205 "product_description": {
241205 "type": "string"
251205 },
26846 "switching": {
27846 "type": "boolean"
28846 },
29795 "switching_from": {
30795 "anyOf": [
312955 {
322955 "enum": [
339n/a "paddle",
343n/a "lemon_squeezy",
352n/a "gumroad",
362n/a "stripe",
3713n/a "other"
382955 ],
393054 "type": "string"
402955 },
415034 {
425034 "type": "null"
435034 }
44795 ],
45795 }
467650 },
471216 "required": [
481252 "about",
491252 "product_description",
501252 "intended_use",
511252 "customer_acquisition",
521252 "future_annual_revenue"
531216 ],
54127235 "type": "object"
5571291}
OrganizationFeatureSettings8 of 8 keywords
182289{
26634 "properties": {
3545 "issue_funding_enabled": {
4545 "type": "boolean"
5545 },
6676 "member_model_enabled": {
7676 "type": "boolean"
8676 },
9739 "revops_enabled": {
10739 "type": "boolean"
11739 },
12425 "seat_based_pricing_enabled": {
13425 "type": "boolean"
14425 },
15389 "wallets_enabled": {
16389 "type": "boolean"
17389 }
186634 },
19116255 "type": "object"
2082289}
OrganizationNotificationSettings7 of 7 keywords
187312{
28910 "properties": {
3935 "new_order": {
4935 "type": "boolean"
5935 },
6935 "new_subscription": {
7935 "type": "boolean"
8935 }
98910 },
10973 "required": [
11982 "new_order",
12982 "new_subscription"
13973 ],
14100299 "type": "object"
1587312}
OrganizationSocialPlatforms0 of 3 keywords
13370{
23370 "enum": [
343n/a "x",
440n/a "github",
528n/a "facebook",
684n/a "instagram",
737n/a "youtube",
839n/a "tiktok",
925n/a "linkedin",
1041n/a "other"
113370 ],
123370 "type": "string"
133370}
OrganizationSubscriptionSettings10 of 10 keywords
168325{
27327 "properties": {
3945 "allow_customer_updates": {
4945 "type": "boolean"
5945 },
6945 "allow_multiple_subscriptions": {
7945 "type": "boolean"
8945 },
9936 "benefit_revocation_grace_period": {
10936 "type": "integer"
11936 },
12945 "prevent_trial_abuse": {
13945 "type": "boolean"
14945 },
15936 "proration_behavior": {
16936 "$ref": "#/components/schemas/SubscriptionProrationBehavior"
17936 }
187327 },
19956 "required": [
20992 "allow_multiple_subscriptions",
21992 "allow_customer_updates",
22992 "proration_behavior",
23992 "benefit_revocation_grace_period",
24992 "prevent_trial_abuse"
25956 ],
26101292 "type": "object"
2768325}
SubscriptionProrationBehavior3 of 3 keywords
1936{
2936 "enum": [
366n/a "invoice",
427n/a "prorate"
5936 ],
6945 "type": "string"
7936}
Responses2 of 2 documented received
codedescriptionhitsavg
201Organization created.1627ms
422Validation Error6916ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized222ms
500Internal Server Error101465ms
400Bad Request3712ms
Examples7 / 7 used
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 Parametersnot covered
idno coverage data
#validinvalidschema
100{
200 "format": "uuid4",
30n/a "type": "string",
400}
Expected Responses0 of 4 documented received
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 Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13790{
23790 "format": "uuid4",
3379n/a "type": "string",
43790}
Responses1 of 3 documented received
codedescriptionhitsavg
200Successful Response1886ms
404Organization not found.0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1912ms
Examples0 / 1 used
Path
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"id
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
17000{
27000 "format": "uuid4",
3700n/a "type": "string",
47000}
Body101 of 101 keywords covered
application/json101 / 101
OrganizationUpdate
1389277{
2231271 "properties": {
340411 "avatar_url": {
440411 "anyOf": [
538134 {
63824 "format": "uri",
73842 "maxLength": 2083,
83851 "minLength": 1,
938629 "type": "string"
1038134 },
1123392 {
1223392 "type": "null"
1323392 }
1440411 ],
1540411 },
1634556 "customer_email_settings": {
1734556 "anyOf": [
1844357 {
1944357 "$ref": "#/components/schemas/OrganizationCustomerEmailSettings"
2044357 },
21301100 {
22301100 "type": "null"
23301100 }
2434556 ]
2534556 },
2633868 "details": {
2733868 "anyOf": [
2848358 {
2948358 "$ref": "#/components/schemas/OrganizationDetails"
3048358 },
31290116 {
32290116 "type": "null"
33290116 }
3433868 ],
3533868 },
364156 "email": {
374156 "anyOf": [
3840417 {
394192 "format": "email",
4040615 "type": "string"
4140417 },
4211410 {
4311410 "type": "null"
4411410 }
454156 ],
464156 },
4737031 "feature_settings": {
4837031 "anyOf": [
4955346 {
5055346 "$ref": "#/components/schemas/OrganizationFeatureSettings"
5155346 },
5231586 {
5331586 "type": "null"
5431586 }
5537031 ]
5637031 },
574005 "name": {
584005 "anyOf": [
5937431 {
603741 "minLength": 3,
6137530 "type": "string"
6237431 },
6326379 {
6426379 "type": "null"
6526379 }
664005 ],
674005 },
6840917 "notification_settings": {
6940917 "anyOf": [
7062364 {
7162364 "$ref": "#/components/schemas/OrganizationNotificationSettings"
7262364 },
7334779 {
7434779 "type": "null"
7534779 }
7640917 ]
7740917 },
7838127 "socials": {
7938127 "anyOf": [
8033672 {
8133622 "items": {
8212823 "$ref": "#/components/schemas/OrganizationSocialLink"
8333622 },
8435850 "type": "array"
8533672 },
8645363 {
8745363 "type": "null"
8845363 }
8938127 ],
9038127 },
9135446 "subscription_settings": {
9235446 "anyOf": [
9337363 {
9437363 "$ref": "#/components/schemas/OrganizationSubscriptionSettings"
9537363 },
9631783 {
9731783 "type": "null"
9831783 }
9935446 ]
10035446 },
10138216 "website": {
10238216 "anyOf": [
10337028 {
1043717 "format": "uri",
1053771 "maxLength": 2083,
1063762 "minLength": 1,
10737820 "type": "string"
10837028 },
10912386 {
11012386 "type": "null"
11112386 }
11238216 ],
11338216 }
114231271 },
1156606 "type": "object"
116389277}
Referenced Components (8)75 of 75 keywords
OrganizationCustomerEmailSettings13 of 13 keywords
144357{
25242 "properties": {
3867 "order_confirmation": {
4867 "type": "boolean"
5867 },
6865 "subscription_cancellation": {
7865 "type": "boolean"
8865 },
9865 "subscription_confirmation": {
10865 "type": "boolean"
11865 },
12865 "subscription_cycled": {
13865 "type": "boolean"
14865 },
15865 "subscription_past_due": {
16865 "type": "boolean"
17865 },
18865 "subscription_revoked": {
19865 "type": "boolean"
20865 },
21865 "subscription_uncanceled": {
22865 "type": "boolean"
23865 },
24865 "subscription_updated": {
25865 "type": "boolean"
26865 }
275242 },
288411 "required": [
29932 "order_confirmation",
30914 "subscription_cancellation",
31914 "subscription_confirmation",
32914 "subscription_cycled",
33914 "subscription_past_due",
34914 "subscription_revoked",
35914 "subscription_uncanceled",
36914 "subscription_updated"
378411 ],
3895306 "type": "object"
3944357}
OrganizationDetails21 of 21 keywords
148358{
25354 "properties": {
31015 "about": {
41015 "type": "string"
51015 },
69610 "customer_acquisition": {
7965 "items": {
81885 "type": "string"
9965 },
101015 "type": "array"
119610 },
12997 "future_annual_revenue": {
131001 "minimum": 0.0,
141006 "type": "integer"
15997 },
16997 "intended_use": {
17997 "type": "string"
18997 },
19847 "previous_annual_revenue": {
20851 "minimum": 0.0,
21856 "type": "integer"
22847 },
231015 "product_description": {
241015 "type": "string"
251015 },
26755 "switching": {
27755 "type": "boolean"
28755 },
29768 "switching_from": {
30768 "anyOf": [
311668 {
321668 "enum": [
336n/a "paddle",
342n/a "lemon_squeezy",
354n/a "gumroad",
361n/a "stripe",
373n/a "other"
381668 ],
392064 "type": "string"
401668 },
416024 {
426024 "type": "null"
436024 }
44768 ],
45768 }
465354 },
4710210 "required": [
481066 "about",
491066 "product_description",
501066 "intended_use",
511066 "customer_acquisition",
521066 "future_annual_revenue"
5310210 ],
54112294 "type": "object"
5548358}
OrganizationFeatureSettings8 of 8 keywords
155346{
24427 "properties": {
3545 "issue_funding_enabled": {
4545 "type": "boolean"
5545 },
6535 "member_model_enabled": {
7535 "type": "boolean"
8535 },
9475 "revops_enabled": {
10475 "type": "boolean"
11475 },
12535 "seat_based_pricing_enabled": {
13535 "type": "boolean"
14535 },
15387 "wallets_enabled": {
16387 "type": "boolean"
17387 }
184427 },
1982319 "type": "object"
2055346}
OrganizationNotificationSettings7 of 7 keywords
162364{
26410 "properties": {
3685 "new_order": {
4685 "type": "boolean"
5685 },
6685 "new_subscription": {
7685 "type": "boolean"
8685 }
96410 },
10723 "required": [
11732 "new_order",
12732 "new_subscription"
13723 ],
1475351 "type": "object"
1562364}
OrganizationSocialPlatforms3 of 3 keywords
11376{
21376 "enum": [
330n/a "x",
417n/a "github",
513n/a "facebook",
617n/a "instagram",
721n/a "youtube",
815n/a "tiktok",
914n/a "linkedin",
1010n/a "other"
111376 ],
121385 "type": "string"
131376}
OrganizationSubscriptionSettings10 of 10 keywords
137363{
24232 "properties": {
36310 "allow_customer_updates": {
46310 "type": "boolean"
56310 },
6685 "allow_multiple_subscriptions": {
7685 "type": "boolean"
8685 },
9676 "benefit_revocation_grace_period": {
10676 "type": "integer"
11676 },
12685 "prevent_trial_abuse": {
13685 "type": "boolean"
14685 },
15676 "proration_behavior": {
16676 "$ref": "#/components/schemas/SubscriptionProrationBehavior"
17676 }
184232 },
19696 "required": [
20732 "allow_multiple_subscriptions",
21732 "allow_customer_updates",
22732 "proration_behavior",
23732 "benefit_revocation_grace_period",
24732 "prevent_trial_abuse"
25696 ],
2675325 "type": "object"
2737363}
SubscriptionProrationBehavior3 of 3 keywords
1676{
2676 "enum": [
345n/a "invoice",
422n/a "prorate"
5676 ],
6685 "type": "string"
7676}
Responses3 of 4 documented received
codedescriptionhitsavg
200Organization updated.1749ms
403You don't have the permission to update this organization.0never seen
404Organization not found.246ms
422Validation Error4456ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error44943ms
401Unauthorized33ms
400Bad Request95ms
Examples8 / 8 used
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 Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
14390{
24390 "format": "uuid4",
3439n/a "type": "string",
44390}
Responses1 of 4 documented received
codedescriptionhitsavg
200Successful Response0never seen
403User is not the admin of the account.0never seen
404Organization not found or account not set.2416ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1982ms
Examples0 / 1 used
Path
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"id
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
11770{
21770 "format": "uuid4",
3177n/a "type": "string",
41770}
Responses2 of 3 documented received
codedescriptionhitsavg
200Organization validated with AI.5239ms
404Organization not found.236ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error82842ms
401Unauthorized203ms
Examples1 / 1 used
Path
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"id
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13781{
23781 "format": "uuid4",
3379n/a "type": "string",
43781}
Body6 of 6 keywords covered
application/json6 / 6
OrganizationAppealRequest
128934{
228917 "properties": {
328917 "reason": {
42961 "maxLength": 5000,
52907 "minLength": 50,
62979 "type": "string"
728917 }
828917 },
930612 "required": [
1030612 "reason"
1130612 ],
123185 "type": "object"
1328934}
Responses4 of 4 documented received
codedescriptionhitsavg
200Appeal submitted successfully.315ms
400Invalid appeal request.294ms
404Organization not found.789ms
422Validation Error2527ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized162ms
500Internal Server Error12059ms
Examples1 / 1 used
Path
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"id
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
14130{
24130 "format": "uuid4",
3413n/a "type": "string",
44130}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response3278ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized312ms
404Not Found556ms
Examples1 / 1 used
Path
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"id
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13760{
23760 "format": "uuid4",
3376n/a "type": "string",
43760}
Body5 of 5 keywords covered
application/json5 / 5
OrganizationMemberInvite
133635{
233628 "properties": {
333628 "email": {
43631 "format": "email",
533727 "type": "string"
633628 }
733628 },
83642 "required": [
93642 "email"
103642 ],
113665 "type": "object"
1233635}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response2097ms
422Validation Error405ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found696ms
401Unauthorized172ms
201Created41106ms
Examples1 / 1 used
Path
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"id
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13990{
23990 "format": "uuid4",
3399n/a "type": "string",
43990}
Query Parameters1 of 1 keywords covered
account_verification_only1 / 1
118323{
218323 "type": "boolean"
318323}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response2637ms
404Organization not found.0never seen
422Validation Error235ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1132ms
Examples1 / 2 used
Path
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"id
Query
falseaccount_verification_only
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
14480{
24480 "format": "uuid4",
3448n/a "type": "string",
44480}
Responses1 of 3 documented received
codedescriptionhitsavg
200Organization review status retrieved.2446ms
404Organization not found.0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2042ms
Examples0 / 1 used
Path
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"id
payments 2 operations 1 covered 1 partial 0 uncovered 0 not measured 50% #
Query Parameters28 of 48 keywords covered
organization_id2 / 7
#validinvalidschema
16050{
26050 "anyOf": [
30605 {
400 "format": "uuid4",
50n/a "type": "string",
60605 },
76050 {
86050 "items": {
96050 "format": "uuid4",
10605n/a "type": "string",
116050 },
126050 "type": "array"
136050 },
140605 {
150605 "type": "null"
160605 }
176050 ],
186050}
checkout_id4 / 7
15186{
25186 "anyOf": [
30524 {
400 "format": "uuid4",
50n/a "type": "string"
60524 },
75186 {
85186 "items": {
95391 "format": "uuid4",
10540n/a "type": "string"
115186 },
125240 "type": "array"
135186 },
140524 {
150524 "type": "null"
160524 }
175186 ],
185186}
order_id4 / 7
11557{
21557 "anyOf": [
30162 {
400 "format": "uuid4",
50n/a "type": "string"
60162 },
71557 {
81557 "items": {
93903 "format": "uuid4",
10393n/a "type": "string"
111557 },
121620 "type": "array"
131557 },
140162 {
150162 "type": "null"
160162 }
171557 ],
181557}
status4 / 7
114816{
214816 "anyOf": [
30164 {
40164 "$ref": "#/components/schemas/PaymentStatus"
50164 },
614816 {
714816 "items": {
826518 "$ref": "#/components/schemas/PaymentStatus"
914816 },
101640 "type": "array"
1114816 },
120164 {
130164 "type": "null"
140164 }
1514816 ],
1614816}
Referenced Components (1)3 of 3 keywords
PaymentStatus3 of 3 keywords
1265182{
2265182 "enum": [
3110n/a "pending",
478n/a "succeeded",
577n/a "failed"
6265182 ],
7268n/a "type": "string"
8265182}
method3 / 5
191n/a{
291n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
69166 {
791n/a "items": {
8250n/a "type": "string"
991n/a },
101570 "type": "array"
119166 },
120157 {
130157 "type": "null"
140157 }
1591n/a ],
1691n/a}
customer_email3 / 5
191n/a{
291n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
69170 {
791n/a "items": {
8344n/a "type": "string"
991n/a },
101610 "type": "array"
119170 },
120161 {
130161 "type": "null"
140161 }
1591n/a ],
1691n/a}
page2 / 2
122516{
22252 "exclusiveMinimum": 0,
322714 "type": "integer"
422516}
limit2 / 2
121023{
22102 "exclusiveMinimum": 0,
321221 "type": "integer"
421023}
sorting4 / 6
112613{
212613 "anyOf": [
312613 {
412613 "items": {
546715 "$ref": "#/components/schemas/PaymentSortProperty"
612613 },
71390 "type": "array"
812613 },
90139 {
100139 "type": "null"
110139 }
1212613 ],
1312613}
Referenced Components (1)3 of 3 keywords
PaymentSortProperty3 of 3 keywords
146715{
246715 "enum": [
348n/a "created_at",
4102n/a "-created_at",
562n/a "status",
652n/a "-status",
767n/a "amount",
834n/a "-amount",
954n/a "method",
1048n/a "-method"
1146715 ],
12469n/a "type": "string"
1346715}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response4327ms
422Validation Error615ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized992ms
500Internal Server Error131518ms
Examples3 / 5 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-created_at" ]sorting
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
12966{
22966 "format": "uuid4",
3302n/a "type": "string"
42966}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Payment not found.2446ms
422Validation Error66ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized522ms
payouts 6 operations 5 covered 1 partial 0 uncovered 0 not measured 78% #
Query Parameters16 of 24 keywords covered
account_id4 / 7
#validinvalidschema
117928{
217928 "anyOf": [
30207 {
400 "format": "uuid4",
50n/a "type": "string"
60207 },
717928 {
817928 "items": {
944297 "format": "uuid4",
10539n/a "type": "string"
1117928 },
122070 "type": "array"
1317928 },
140207 {
150207 "type": "null"
160207 }
1717928 ],
1817928}
status4 / 7
113740{
213740 "anyOf": [
30177 {
40177 "$ref": "#/components/schemas/PayoutStatus"
50177 },
613740 {
713740 "items": {
8440105 "$ref": "#/components/schemas/PayoutStatus"
913740 },
101770 "type": "array"
1113740 },
120177 {
130177 "type": "null"
140177 }
1513740 ],
1613740}
Referenced Components (1)3 of 3 keywords
PayoutStatus3 of 3 keywords
1440282{
2440282 "enum": [
3189n/a "pending",
4115n/a "in_transit",
5136n/a "succeeded"
6440282 ],
7508n/a "type": "string"
8440282}
page2 / 2
118039{
21806 "exclusiveMinimum": 0,
318633 "type": "integer"
418039}
limit2 / 2
119636{
21968 "exclusiveMinimum": 0,
320428 "type": "integer"
419636}
sorting4 / 6
110426{
210426 "anyOf": [
310426 {
410426 "items": {
531944 "$ref": "#/components/schemas/PayoutSortProperty"
610426 },
71300 "type": "array"
810426 },
90130 {
100130 "type": "null"
110130 }
1210426 ],
1310426}
Referenced Components (1)3 of 3 keywords
PayoutSortProperty3 of 3 keywords
131944{
231944 "enum": [
318n/a "created_at",
456n/a "-created_at",
532n/a "amount",
619n/a "-amount",
722n/a "fees_amount",
826n/a "-fees_amount",
917n/a "status",
1021n/a "-status",
1119n/a "paid_at",
1226n/a "-paid_at",
1334n/a "account_id",
1429n/a "-account_id"
1531944 ],
16345n/a "type": "string"
1731944}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response4137ms
422Validation Error975ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized832ms
500Internal Server Error161730ms
Examples3 / 3 used
Query
1page
10limit
[ "-created_at" ]sorting
Body5 of 5 keywords covered
application/json5 / 5
PayoutCreate
#validinvalidschema
152735{
25279 "properties": {
35279 "account_id": {
45271 "format": "uuid4",
55288 "type": "string"
65279 }
75279 },
853621 "required": [
953621 "account_id"
1053621 ],
115575 "type": "object"
1252735}
Responses1 of 2 documented received
codedescriptionhitsavg
201Successful Response0never seen
422Validation Error475ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found5057ms
401Unauthorized222ms
400Bad Request65ms
Query Parameters2 of 2 keywords covered
account_id2 / 2
#validinvalidschema
15576{
25576 "format": "uuid4",
3563n/a "type": "string"
45576}
Responses2 of 5 documented received
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.5156ms
422Validation Error75ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized422ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13066{
23066 "format": "uuid4",
3312n/a "type": "string"
43066}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error65ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2816ms
401Unauthorized252ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13024{
23024 "format": "uuid4",
3306n/a "type": "string"
43024}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error45ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2896ms
401Unauthorized132ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
130815{
230815 "format": "uuid4",
3323n/a "type": "string"
430815}
Body5 of 5 keywords covered
application/json5 / 5
PayoutGenerateInvoice
128422{
27016 "properties": {
37016 "invoice_number": {
47016 "anyOf": [
53452 {
63452 "type": "string"
73452 },
83650 {
93650 "type": "null"
103650 }
117016 ],
127016 }
137016 },
143006 "type": "object"
1528422}
Responses1 of 2 documented received
codedescriptionhitsavg
202Successful Response0never seen
422Validation Error355ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2736ms
401Unauthorized82ms
400Bad Request74ms
personal_access_token 2 operations 1 covered 0 partial 1 uncovered 0 not measured 66% #
Query Parameters4 of 4 keywords covered
page2 / 2
#validinvalidschema
17345{
27316 "exclusiveMinimum": 0,
38929 "type": "integer"
47345}
limit2 / 2
111646{
211619 "exclusiveMinimum": 0,
313527 "type": "integer"
411646}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response1705ms
422Validation Error544ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1092ms
Examples2 / 2 used
Query
1page
10limit
Path Parametersnot covered
idno coverage data
#validinvalidschema
100{
200 "format": "uuid4",
30n/a "type": "string"
400}
Expected Responses0 of 2 documented received
codedescriptionhitsavg
204Successful Response0never seen
422Validation Error0never seen
products 5 operations 0 covered 5 partial 0 uncovered 0 not measured 88% #
Query Parameters29 of 53 keywords covered
id3 / 7
#validinvalidschema
16718{
26718 "anyOf": [
30679 {
400 "format": "uuid4",
50n/a "type": "string",
60679 },
76718 {
86718 "items": {
96890 "format": "uuid4",
10689n/a "type": "string",
116718 },
126790 "type": "array"
136718 },
140679 {
150679 "type": "null"
160679 }
176718 ],
186718}
organization_id2 / 7
18260{
28260 "anyOf": [
30826 {
400 "format": "uuid4",
50n/a "type": "string",
60826 },
78260 {
88260 "items": {
98260 "format": "uuid4",
10826n/a "type": "string",
118260 },
128260 "type": "array"
138260 },
140826 {
150826 "type": "null"
160826 }
178260 ],
188260}
query3 / 3
1211n/a{
2211n/a "anyOf": [
3207n/a {
4207n/a "type": "string"
5207n/a },
64207 {
74207 "type": "null"
84207 }
9211n/a ],
10211n/a}
is_archived3 / 3
12197{
22197 "anyOf": [
321511 {
421511 "type": "boolean"
521511 },
64222 {
74222 "type": "null"
84222 }
92197 ],
102197}
is_recurring3 / 3
12016{
22016 "anyOf": [
319314 {
419314 "type": "boolean"
519314 },
68199 {
78199 "type": "null"
88199 }
92016 ],
102016}
benefit_id3 / 7
12614{
22614 "anyOf": [
30265 {
400 "format": "uuid4",
50n/a "type": "string",
60265 },
72614 {
82614 "items": {
96840 "format": "uuid4",
10684n/a "type": "string",
112614 },
122650 "type": "array"
132614 },
140265 {
150265 "type": "null"
160265 }
172614 ],
182614}
page2 / 2
132019{
23202 "exclusiveMinimum": 0,
332217 "type": "integer"
432019}
limit2 / 2
131233{
23126 "exclusiveMinimum": 0,
331827 "type": "integer"
431233}
sorting4 / 6
119116{
219116 "anyOf": [
319116 {
419116 "items": {
579218 "$ref": "#/components/schemas/ProductSortProperty"
619116 },
72070 "type": "array"
819116 },
90207 {
100207 "type": "null"
110207 }
1219116 ],
1319116}
Referenced Components (1)3 of 3 keywords
ProductSortProperty3 of 3 keywords
179218{
279218 "enum": [
385n/a "created_at",
4187n/a "-created_at",
598n/a "name",
687n/a "-name",
774n/a "price_amount_type",
899n/a "-price_amount_type",
975n/a "price_amount",
1087n/a "-price_amount"
1179218 ],
12794n/a "type": "string"
1379218}
metadata4 / 13
MetadataQuery
11310{
21310 "anyOf": [
31310 {
41310 "additionalProperties": {
52990 "anyOf": [
6186113 {
7186113 "type": "string"
8186113 },
90299 {
100299 "type": "integer"
110299 },
120299 {
130299 "type": "boolean"
140299 },
15113186 {
161130 "items": {
177000 "type": "string"
181130 },
19113186 "type": "array"
20113186 },
210299 {
220113 "items": {
230700 "type": "integer"
240113 },
25113186 "type": "array"
260299 },
270299 {
280113 "items": {
290700 "type": "boolean"
300113 },
31113186 "type": "array"
320299 }
332990 ]
341310 },
351310 "type": "object"
361310 },
370131 {
380131 "type": "null"
390131 }
401310 ],
411310}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response61410ms
422Validation Error695ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1172ms
500Internal Server Error261606ms
Examples3 / 5 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-created_at" ]sorting
Body177 of 185 keywords covered
application/json177 / 185
ProductCreate
#validinvalidschema
17011445{
27011445 "anyOf": [
33771769 {
43771769 "$ref": "#/components/schemas/ProductCreateRecurring"
53771769 },
63241822 {
73241822 "$ref": "#/components/schemas/ProductCreateOneTime"
83241822 }
97011445 ]
107011445}
Referenced Components (12)214 of 222 keywords
AttachedCustomFieldCreate7 of 8 keywords
11008204{
21032120 "properties": {
3108060 "custom_field_id": {
410800 "format": "uuid4",
5108060 "type": "string"
6108060 },
7108060 "required": {
8108060 "type": "boolean"
9108060 }
101032120 },
11112824 "required": [
12114012 "custom_field_id",
13114012 "required"
14112824 ],
15115260 "type": "object"
161008204}
ProductCreateOneTime44 of 47 keywords
13241822{
23301801 "properties": {
31818132 "attached_custom_fields": {
41818102 "items": {
5504102 "$ref": "#/components/schemas/AttachedCustomFieldCreate"
61818102 },
7192030 "type": "array"
81818132 },
9192125 "description": {
10192125 "anyOf": [
11941852 {
12941852 "type": "string"
13941852 },
141827119 {
151827119 "type": "null"
161827119 }
17192125 ],
18192125 },
19188361 "medias": {
20188361 "anyOf": [
211823121 {
22182337 "items": {
232266 "format": "uuid4",
2423242 "type": "string"
25182337 },
26186084 "type": "array"
271823121 },
28601884 {
29601884 "type": "null"
30601884 }
31188361 ],
32188361 },
33189242 "metadata": {
347712 "additionalProperties": {
3527812 "anyOf": [
3670220 {
37820 "maxLength": 500,
387012 "minLength": 1,
3982208 "type": "string"
4070220 },
4172218 {
4272218 "type": "integer"
4372218 },
44100190 {
45100190 "type": "number"
46100190 },
47108182 {
48108182 "type": "boolean"
49108182 }
5027812 ]
517712 },
5219040 "maxProperties": 50,
537712 "propertyNames": {
542846 "maxLength": 40,
552846 "minLength": 1
567712 },
57190430 "type": "object"
58189242 },
59208836 "name": {
6020886 "minLength": 3,
61209430 "type": "string"
62208836 },
63204424 "organization_id": {
64204424 "anyOf": [
65203830 {
6620380 "format": "uuid4",
67203830 "type": "string",
68203830 },
6962062 {
7062062 "type": "null"
7162062 }
72204424 ],
73204424 },
741136988 "prices": {
751142952 "items": {
761937973 "oneOf": [
778542056 {
788542056 "$ref": "#/components/schemas/ProductPriceFixedCreate"
798542056 },
803012609 {
813012609 "$ref": "#/components/schemas/ProductPriceCustomCreate"
823012609 },
832192691 {
842192691 "$ref": "#/components/schemas/ProductPriceFreeCreate"
852192691 },
862442666 {
872442666 "$ref": "#/components/schemas/ProductPriceSeatBasedCreate"
882442666 },
893192591 {
903192591 "$ref": "#/components/schemas/ProductPriceMeteredUnitCreate"
913192591 }
921937973 ]
931142952 },
9420886 "minItems": 1,
95209430 "type": "array"
961136988 },
979011126 "recurring_interval": {
989011126 "type": "null"
999011126 },
1008951020 "recurring_interval_count": {
1018951020 "type": "null"
1028951020 }
1033301801 },
104211813 "required": [
10521247 "name",
10621247 "prices"
107211813 ],
108213115 "type": "object"
1093241822}
ProductCreateRecurring56 of 59 keywords
13771769{
24661665 "properties": {
31818132 "attached_custom_fields": {
41818102 "items": {
5504102 "$ref": "#/components/schemas/AttachedCustomFieldCreate"
61818102 },
7192030 "type": "array"
81818132 },
9192125 "description": {
10192125 "anyOf": [
11941852 {
12941852 "type": "string"
13941852 },
141827119 {
151827119 "type": "null"
161827119 }
17192125 ],
18192125 },
19188361 "medias": {
20188361 "anyOf": [
211823121 {
22182337 "items": {
232266 "format": "uuid4",
2423242 "type": "string"
25182337 },
26186084 "type": "array"
271823121 },
28601884 {
29601884 "type": "null"
30601884 }
31188361 ],
32188361 },
33189242 "metadata": {
347712 "additionalProperties": {
3527812 "anyOf": [
3670220 {
37820 "maxLength": 500,
387012 "minLength": 1,
3982208 "type": "string"
4070220 },
4172218 {
4272218 "type": "integer"
4372218 },
44100190 {
45100190 "type": "number"
46100190 },
47108182 {
48108182 "type": "boolean"
49108182 }
5027812 ]
517712 },
5219040 "maxProperties": 50,
537712 "propertyNames": {
542846 "maxLength": 40,
552846 "minLength": 1
567712 },
57190430 "type": "object"
58189242 },
59208836 "name": {
6020886 "minLength": 3,
61209430 "type": "string"
62208836 },
63204424 "organization_id": {
64204424 "anyOf": [
65203830 {
6620380 "format": "uuid4",
67203830 "type": "string",
68203830 },
6962062 {
7062062 "type": "null"
7162062 }
72204424 ],
73204424 },
741136988 "prices": {
751142952 "items": {
761937973 "oneOf": [
778542056 {
788542056 "$ref": "#/components/schemas/ProductPriceFixedCreate"
798542056 },
803012609 {
813012609 "$ref": "#/components/schemas/ProductPriceCustomCreate"
823012609 },
832192691 {
842192691 "$ref": "#/components/schemas/ProductPriceFreeCreate"
852192691 },
862442666 {
872442666 "$ref": "#/components/schemas/ProductPriceSeatBasedCreate"
882442666 },
893192591 {
903192591 "$ref": "#/components/schemas/ProductPriceMeteredUnitCreate"
913192591 }
921937973 ]
931142952 },
9420886 "minItems": 1,
95209430 "type": "array"
961136988 },
971095932 "recurring_interval": {
981095932 "$ref": "#/components/schemas/SubscriptionRecurringInterval",
991095932 },
100983932 "recurring_interval_count": {
1019923 "maximum": 999.0,
1029869 "minimum": 1.0,
103992923 "type": "integer"
104983932 },
10598216 "trial_interval": {
10698216 "anyOf": [
10730968 {
10830968 "$ref": "#/components/schemas/TrialInterval"
10930968 },
11095246 {
11195246 "type": "null"
11295246 }
11398216 ],
11498216 },
11597021 "trial_interval_count": {
11697021 "anyOf": [
11795932 {
1189653 "maximum": 1000.0,
1199626 "minimum": 1.0,
12096526 "type": "integer"
12195932 },
12211980 {
12311980 "type": "null"
12411980 }
12597021 ],
12697021 }
1274661665 },
1282014117 "required": [
12921247 "name",
13021247 "prices",
1312027104 "recurring_interval"
1322014117 ],
133213115 "type": "object"
1343771769}
ProductPriceCustomCreate27 of 27 keywords
16025218{
26505052 "properties": {
39664688 "amount_type": {
49664688 "const": "custom",
55354300 "type": "string"
69664688 },
760696 "maximum_amount": {
860696 "anyOf": [
9534168 {
1057012 "maximum": 1000000.0,
1154636 "minimum": 50.0,
12570132 "type": "integer"
13534168 },
1472630 {
1572630 "type": "null"
1672630 }
1760696 ],
1860696 },
1961696 "minimum_amount": {
2061696 "anyOf": [
21520192 {
2255612 "maximum": 99999999.0,
2353236 "minimum": 50.0,
24556156 "type": "integer"
25520192 },
2696616 {
2796616 "type": "null"
2896616 }
2961696 ],
3061696 },
31622100 "preset_amount": {
32622100 "anyOf": [
33542180 {
3458014 "maximum": 1000000.0,
3555638 "minimum": 50.0,
36582140 "type": "integer"
37542180 },
3880642 {
3980642 "type": "null"
4080642 }
41622100 ],
42622100 },
432382292 "price_currency": {
44238252 "pattern": "usd",
452434240 "type": "string"
462382292 }
476505052 },
48565460 "required": [
49565460 "amount_type"
50565460 ],
515714106 "type": "object"
526025218}
ProductPriceFixedCreate12 of 12 keywords
117084112{
217683934 "properties": {
318883766 "amount_type": {
418883766 "const": "fixed",
55354300 "type": "string"
618883766 },
7186496 "price_amount": {
8188812 "maximum": 99999999.0,
9187624 "minimum": 50.0,
10188872 "type": "integer"
11186496 },
122382292 "price_currency": {
13238252 "pattern": "usd",
142434240 "type": "string"
152382292 }
1617683934 },
1719483766 "required": [
18565460 "amount_type",
1919603754 "price_amount"
2019483766 ],
215714106 "type": "object"
2217084112}
ProductPriceFreeCreate7 of 7 keywords
14385382{
24385216 "properties": {
34385216 "amount_type": {
44385216 "const": "free",
55354300 "type": "string"
64385216 }
74385216 },
8565460 "required": [
9565460 "amount_type"
10565460 ],
115714106 "type": "object"
124385382}
ProductPriceMeteredUnitCreate22 of 23 keywords
16385182{
27104992 "properties": {
39504704 "amount_type": {
49504704 "const": "metered_unit",
55354300 "type": "string"
69504704 },
765284 "cap_amount": {
865284 "anyOf": [
9516220 {
1054012 "maximum": 2147483647.0,
1154012 "minimum": 0.0,
12540196 "type": "integer"
13516220 },
14136600 {
15136600 "type": "null"
16136600 }
1765284 ],
1865284 },
1996260 "meter_id": {
209620 "format": "uuid4",
2196260 "type": "string"
2296260 },
232382292 "price_currency": {
24238252 "pattern": "usd",
252434240 "type": "string"
262382292 },
2795072 "unit_amount": {
2895072 "anyOf": [
29746276 {
3074612 "exclusiveMinimum": 0.0,
31758264 "type": "number"
32746276 },
33204818 {
3420412 "pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,5}|(?=[\\d.]{1,18}0*$)\\d{0,5}\\.\\d{0,12}0*$)",
35216806 "type": "string"
36204818 }
3795072 ],
3895072 }
397104992 },
409984716 "required": [
41565460 "amount_type",
4210224692 "meter_id",
4310224692 "unit_amount"
449984716 ],
455714106 "type": "object"
466385182}
ProductPriceSeatBasedCreate10 of 10 keywords
14885332{
25485154 "properties": {
310524602 "amount_type": {
410524602 "const": "seat_based",
55354300 "type": "string"
610524602 },
72382292 "price_currency": {
8238252 "pattern": "usd",
92434240 "type": "string"
102382292 },
11644480 "seat_tiers": {
12644480 "$ref": "#/components/schemas/ProductPriceSeatTiers",
13644480 }
145485154 },
1511124602 "required": [
16565460 "amount_type",
1711244590 "seat_tiers"
1811124602 ],
195714106 "type": "object"
204885332}
ProductPriceSeatTier15 of 15 keywords
12152336{
22176252 "properties": {
3113872 "max_seats": {
4113872 "anyOf": [
5832378 {
683224 "minimum": 1.0,
7844366 "type": "integer"
8832378 },
9306904 {
10306904 "type": "null"
11306904 }
12113872 ],
13113872 },
14233284 "min_seats": {
15233224 "minimum": 1.0,
16234472 "type": "integer"
17233284 },
18232096 "price_per_seat": {
19234412 "maximum": 99999999.0,
20234412 "minimum": 0.0,
21234472 "type": "integer"
22232096 }
232176252 },
24240424 "required": [
25241612 "min_seats",
26241612 "price_per_seat"
27240424 ],
28242860 "type": "object"
292152336}
ProductPriceSeatTiers8 of 8 keywords
1644480{
2644408 "properties": {
3644408 "tiers": {
4656336 "items": {
52152336 "$ref": "#/components/schemas/ProductPriceSeatTier"
6656336 },
798012 "minItems": 1,
899260 "type": "array"
9644408 }
10644408 },
11105212 "required": [
12105212 "tiers"
13105212 ],
14106460 "type": "object"
15644480}
SubscriptionRecurringInterval3 of 3 keywords
11095932{
21095932 "enum": [
31009n/a "day",
437n/a "week",
525n/a "month",
624n/a "year"
71095932 ],
81101926 "type": "string"
91095932}
TrialInterval3 of 3 keywords
130968{
230968 "enum": [
33n/a "day",
46n/a "week",
55n/a "month",
616n/a "year"
730968 ],
833965 "type": "string"
930968}
Responses1 of 2 documented received
codedescriptionhitsavg
201Product created.0never seen
422Validation Error20995ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error541320ms
400Bad Request55ms
401Unauthorized73ms
Examples7 / 7 used
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 Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13350{
23350 "format": "uuid4",
3335n/a "type": "string",
43350}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response27210ms
404Product not found.346ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized292ms
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
19270{
29270 "format": "uuid4",
3927n/a "type": "string",
49270}
Body150 of 156 keywords covered
application/json150 / 156
ProductUpdate
1399505{
2260494 "properties": {
365544 "attached_custom_fields": {
465544 "anyOf": [
564059 {
664036 "items": {
76838 "$ref": "#/components/schemas/AttachedCustomFieldCreate"
864036 },
967623 "type": "array"
1064059 },
1115684 {
1215684 "type": "null"
1315684 }
1465544 ],
1565544 },
166858 "description": {
176858 "anyOf": [
1829664 {
1929664 "type": "string"
2029664 },
2165637 {
2265637 "type": "null"
2365637 }
246858 ],
256858 },
266808 "is_archived": {
276808 "anyOf": [
2816672 {
2916672 "type": "boolean"
3016672 },
3166424 {
3266424 "type": "null"
3366424 }
346808 ],
356808 },
3667426 "medias": {
3767426 "anyOf": [
3864951 {
3964912 "items": {
40870 "format": "uuid4",
418714 "type": "string"
4264912 },
4366139 "type": "array"
4464951 },
4525675 {
4625675 "type": "null"
4725675 }
4867426 ],
4967426 },
5067114 "metadata": {
51254 "additionalProperties": {
52764 "anyOf": [
533446 {
54380 "maxLength": 500,
55344 "minLength": 1,
563842 "type": "string"
573446 },
581268 {
591268 "type": "integer"
601268 },
611862 {
621862 "type": "number"
631862 },
642456 {
652456 "type": "boolean"
662456 }
67764 ]
68254 },
696750 "maxProperties": 50,
70254 "propertyNames": {
71782 "maxLength": 40,
72782 "minLength": 1
73254 },
7467510 "type": "object"
7567114 },
7667810 "name": {
7767810 "anyOf": [
7866820 {
796682 "minLength": 3,
8067018 "type": "string"
8166820 },
8210678 {
8310678 "type": "null"
8410678 }
8567810 ],
8667810 },
87342336 "prices": {
88342336 "anyOf": [
89316362 {
90316328 "items": {
91121330 "anyOf": [
929442 {
939442 "$ref": "#/components/schemas/ExistingProductPrice"
949442 },
95112339 {
96112339 "oneOf": [
9712439 {
9812439 "$ref": "#/components/schemas/ProductPriceFixedCreate"
9912439 },
10039412 {
10139412 "$ref": "#/components/schemas/ProductPriceCustomCreate"
10239412 },
1034447 {
1044447 "$ref": "#/components/schemas/ProductPriceFreeCreate"
1054447 },
10629422 {
10729422 "$ref": "#/components/schemas/ProductPriceSeatBasedCreate"
10829422 },
10928423 {
11028423 "$ref": "#/components/schemas/ProductPriceMeteredUnitCreate"
11128423 }
112112339 ]
113112339 }
114121330 ]
115316328 },
11664434 "type": "array"
117316362 },
11826652 {
11926652 "type": "null"
12026652 }
121342336 ],
122342336 },
12366910 "recurring_interval": {
12466910 "anyOf": [
12534645 {
12634645 "$ref": "#/components/schemas/SubscriptionRecurringInterval"
12734645 },
12863544 {
12963544 "type": "null"
13063544 }
13166910 ],
13266910 },
13366114 "recurring_interval_count": {
13466114 "anyOf": [
13565124 {
1366552 "maximum": 999.0,
1376534 "minimum": 1.0,
13865520 "type": "integer"
13965124 },
14010665 {
14110665 "type": "null"
14210665 }
14366114 ],
14466114 },
14567110 "trial_interval": {
14667110 "anyOf": [
14740641 {
14840641 "$ref": "#/components/schemas/TrialInterval"
14940641 },
15063150 {
15163150 "type": "null"
15263150 }
15367110 ],
15467110 },
15566614 "trial_interval_count": {
15666614 "anyOf": [
15765723 {
1586612 "maximum": 1000.0,
1596594 "minimum": 1.0,
16066119 "type": "integer"
16165723 },
1629671 {
1639671 "type": "null"
1649671 }
16566614 ],
16666614 }
167260494 },
16889311 "type": "object"
169399505}
Referenced Components (11)120 of 123 keywords
AttachedCustomFieldCreate7 of 8 keywords
16838{
27220 "properties": {
38010 "custom_field_id": {
4800 "format": "uuid4",
58010 "type": "string"
68010 },
78010 "required": {
88010 "type": "boolean"
98010 }
107220 },
11884 "required": [
12902 "custom_field_id",
13902 "required"
14884 ],
159214 "type": "object"
166838}
ExistingProductPrice6 of 7 keywords
19442{
2910 "properties": {
3910 "id": {
490 "format": "uuid4",
5910 "type": "string"
6910 }
7910 },
819418 "required": [
919418 "id"
1019418 ],
1143714 "type": "object"
129442}
ProductPriceCustomCreate27 of 27 keywords
139412{
247369 "properties": {
399309 "amount_type": {
499309 "const": "custom",
535850 "type": "string"
699309 },
76916 "maximum_amount": {
86916 "anyOf": [
96718 {
10732 "maximum": 1000000.0,
11696 "minimum": 50.0,
127312 "type": "integer"
136718 },
14283 {
15283 "type": "null"
16283 }
176916 ],
186916 },
197016 "minimum_amount": {
207016 "anyOf": [
216818 {
22742 "maximum": 99999999.0,
23706 "minimum": 50.0,
247412 "type": "integer"
256818 },
26284 {
27284 "type": "null"
28284 }
297016 ],
307016 },
316916 "preset_amount": {
326916 "anyOf": [
336718 {
34732 "maximum": 1000000.0,
35696 "minimum": 50.0,
367312 "type": "integer"
376718 },
38283 {
39283 "type": "null"
40283 }
416916 ],
426916 },
4327648 "price_currency": {
442768 "pattern": "usd",
4528440 "type": "string"
4627648 }
4747369 },
4840829 "required": [
4940829 "amount_type"
5040829 ],
5143714 "type": "object"
5239412}
ProductPriceFixedCreate12 of 12 keywords
112439{
222394 "properties": {
342366 "amount_type": {
442366 "const": "fixed",
535850 "type": "string"
642366 },
73816 "price_amount": {
8422 "maximum": 99999999.0,
9404 "minimum": 50.0,
104212 "type": "integer"
113816 },
1227648 "price_currency": {
132768 "pattern": "usd",
1428440 "type": "string"
1527648 }
1622394 },
1752385 "required": [
1840829 "amount_type",
1954383 "price_amount"
2052385 ],
2143714 "type": "object"
2212439}
ProductPriceFreeCreate7 of 7 keywords
14447{
24404 "properties": {
34404 "amount_type": {
44404 "const": "free",
535850 "type": "string"
64404 }
74404 },
840829 "required": [
940829 "amount_type"
1040829 ],
1143714 "type": "object"
124447}
ProductPriceMeteredUnitCreate22 of 23 keywords
128423{
240376 "properties": {
380328 "amount_type": {
480328 "const": "metered_unit",
535850 "type": "string"
680328 },
77314 "cap_amount": {
87314 "anyOf": [
96027 {
10642 "maximum": 2147483647.0,
11642 "minimum": 0.0,
126423 "type": "integer"
136027 },
141374 {
151374 "type": "null"
161374 }
177314 ],
187314 },
198210 "meter_id": {
20820 "format": "uuid4",
218210 "type": "string"
228210 },
2327648 "price_currency": {
242768 "pattern": "usd",
2528440 "type": "string"
2627648 },
278012 "unit_amount": {
288012 "anyOf": [
297715 {
30772 "exclusiveMinimum": 0.0,
317913 "type": "number"
327715 },
33389 {
3432 "pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,5}|(?=[\\d.]{1,18}0*$)\\d{0,5}\\.\\d{0,12}0*$)",
35587 "type": "string"
36389 }
378012 ],
388012 }
3940376 },
4088349 "required": [
4140829 "amount_type",
4292345 "meter_id",
4392345 "unit_amount"
4488349 ],
4543714 "type": "object"
4628423}
ProductPriceSeatBasedCreate10 of 10 keywords
129422{
239377 "properties": {
3123285 "amount_type": {
4123285 "const": "seat_based",
535850 "type": "string"
6123285 },
727648 "price_currency": {
82768 "pattern": "usd",
928440 "type": "string"
1027648 },
115580 "seat_tiers": {
125580 "$ref": "#/components/schemas/ProductPriceSeatTiers",
135580 }
1439377 },
15133304 "required": [
1640829 "amount_type",
17135302 "seat_tiers"
18133304 ],
1943714 "type": "object"
2029422}
ProductPriceSeatTier15 of 15 keywords
18356{
28742 "properties": {
36612 "max_seats": {
46612 "anyOf": [
56117 {
6614 "minimum": 1.0,
76315 "type": "integer"
86117 },
9573 {
10573 "type": "null"
11573 }
126612 ],
136612 },
1411314 "min_seats": {
151134 "minimum": 1.0,
1611512 "type": "integer"
1711314 },
1811116 "price_per_seat": {
191152 "maximum": 99999999.0,
201152 "minimum": 0.0,
2111512 "type": "integer"
2211116 }
238742 },
241254 "required": [
251272 "min_seats",
261272 "price_per_seat"
271254 ],
2812910 "type": "object"
298356}
ProductPriceSeatTiers8 of 8 keywords
15580{
25568 "properties": {
35568 "tiers": {
45756 "items": {
58356 "$ref": "#/components/schemas/ProductPriceSeatTier"
65756 },
71112 "minItems": 1,
811310 "type": "array"
95568 }
105568 },
111232 "required": [
121232 "tiers"
131232 ],
1412510 "type": "object"
155580}
SubscriptionRecurringInterval3 of 3 keywords
134645{
234645 "enum": [
39n/a "day",
46n/a "week",
515n/a "month",
64n/a "year"
734645 ],
836643 "type": "string"
934645}
TrialInterval3 of 3 keywords
140641{
240641 "enum": [
36n/a "day",
414n/a "week",
57n/a "month",
613n/a "year"
740641 ],
842639 "type": "string"
940641}
Responses3 of 4 documented received
codedescriptionhitsavg
200Product updated.15971ms
403You don't have the permission to update this product.0never seen
404Product not found.87ms
422Validation Error7246ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized143ms
500Internal Server Error141331ms
400Bad Request85ms
Examples4 / 4 used
Body: application/json
"usd"ProductPriceFixedCreate.price_currency
"usd"ProductPriceCustomCreate.price_currency
"usd"ProductPriceSeatBasedCreate.price_currency
"usd"ProductPriceMeteredUnitCreate.price_currency
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
15250{
25250 "format": "uuid4",
3525n/a "type": "string",
45250}
Body5 of 6 keywords covered
application/json5 / 6
ProductBenefitsUpdate
148125{
248110 "properties": {
348110 "benefits": {
44815 "items": {
52720 "format": "uuid4",
62725 "type": "string",
74815 },
84865 "type": "array"
948110 }
1048110 },
1149110 "required": [
1249110 "benefits"
1349110 ],
145015 "type": "object"
1548125}
Responses3 of 4 documented received
codedescriptionhitsavg
200Product benefits updated.37325ms
403You don't have the permission to update this product.0never seen
404Product not found.4415ms
422Validation Error928ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized163ms
refunds 2 operations 0 covered 2 partial 0 uncovered 0 not measured 61% #
Query Parameters27 of 48 keywords covered
id4 / 7
#validinvalidschema
124710{
224710 "anyOf": [
30257 {
400 "format": "uuid4",
50n/a "type": "string"
60257 },
724710 {
824710 "items": {
97275 "format": "uuid4",
10732n/a "type": "string"
1124710 },
122570 "type": "array"
1324710 },
140257 {
150257 "type": "null"
160257 }
1724710 ],
1824710}
organization_id2 / 7
18770{
28770 "anyOf": [
30877 {
400 "format": "uuid4",
50n/a "type": "string",
60877 },
78770 {
88770 "items": {
98770 "format": "uuid4",
10877n/a "type": "string",
118770 },
128770 "type": "array"
138770 },
140877 {
150877 "type": "null"
160877 }
178770 ],
188770}
order_id3 / 7
123910{
223910 "anyOf": [
30249 {
400 "format": "uuid4",
50n/a "type": "string"
60249 },
723910 {
823910 "items": {
96090 "format": "uuid4",
10609n/a "type": "string"
1123910 },
122490 "type": "array"
1323910 },
140249 {
150249 "type": "null"
160249 }
1723910 ],
1823910}
subscription_id4 / 7
144412{
244412 "anyOf": [
30456 {
400 "format": "uuid4",
50n/a "type": "string"
60456 },
744412 {
844412 "items": {
976550 "format": "uuid4",
10815n/a "type": "string"
1144412 },
124560 "type": "array"
1344412 },
140456 {
150456 "type": "null"
160456 }
1744412 ],
1844412}
customer_id3 / 7
13029{
23029 "anyOf": [
30311 {
400 "format": "uuid4",
50n/a "type": "string"
60311 },
73029 {
83029 "items": {
97210 "format": "uuid4",
10721n/a "type": "string"
113029 },
123110 "type": "array"
133029 },
140311 {
150311 "type": "null"
160311 }
173029 ],
183029}
succeeded3 / 3
12086{
22086 "anyOf": [
320014 {
420014 "type": "boolean"
520014 },
68206 {
78206 "type": "null"
88206 }
92086 ],
102086}
page2 / 2
135022{
23504 "exclusiveMinimum": 0,
335418 "type": "integer"
435022}
limit2 / 2
137726{
23772 "exclusiveMinimum": 0,
337924 "type": "integer"
437726}
sorting4 / 6
119114{
219114 "anyOf": [
319114 {
419114 "items": {
571616 "$ref": "#/components/schemas/RefundSortProperty"
619114 },
72050 "type": "array"
819114 },
90205 {
100205 "type": "null"
110205 }
1219114 ],
1319114}
Referenced Components (1)3 of 3 keywords
RefundSortProperty3 of 3 keywords
171616{
271616 "enum": [
3191n/a "created_at",
4245n/a "-created_at",
5164n/a "amount",
6116n/a "-amount"
771616 ],
8718n/a "type": "string"
971616}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response6677ms
422Validation Error725ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1282ms
500Internal Server Error101585ms
Examples3 / 5 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-created_at" ]sorting
Body23 of 25 keywords covered
application/json23 / 25
RefundCreate
#validinvalidschema
142971{
243658 "properties": {
348310 "amount": {
44841 "exclusiveMinimum": 0.0,
54849 "type": "integer"
648310 },
723815 "comment": {
823815 "anyOf": [
9151102 {
10151102 "type": "string"
11151102 },
1287166 {
1387166 "type": "null"
1487166 }
1523815 ],
1623815 },
1725816 "metadata": {
181738 "additionalProperties": {
1954515 "anyOf": [
20188372 {
211901 "maxLength": 500,
221892 "minLength": 1,
23191369 "type": "string"
24188372 },
25140420 {
26140420 "type": "integer"
27140420 },
28188372 {
29188372 "type": "number"
30188372 },
31169391 {
32169391 "type": "boolean"
33169391 }
3454515 ]
351738 },
362660 "maxProperties": 50,
371792 "propertyNames": {
385591 "maxLength": 40,
395591 "minLength": 1
401792 },
412668 "type": "object"
4225816 },
434865 "order_id": {
444860 "format": "uuid4",
454865 "type": "string"
464865 },
474847 "reason": {
484847 "$ref": "#/components/schemas/RefundReason"
494847 },
502425 "revoke_benefits": {
512425 "type": "boolean"
522425 }
5343658 },
544877 "required": [
554913 "order_id",
564913 "reason",
574931 "amount"
584877 ],
594946 "type": "object"
6042971}
Referenced Components (1)3 of 3 keywords
RefundReason3 of 3 keywords
14847{
24847 "enum": [
3109n/a "duplicate",
459n/a "fraudulent",
589n/a "customer_request",
649n/a "service_disruption",
760n/a "satisfaction_guarantee",
8118n/a "other"
94847 ],
104865 "type": "string"
114847}
Responses2 of 5 documented received
codedescriptionhitsavg
200Successful Response0never seen
201Refund created.0never seen
400Refund amount exceeds remaining order balance.914ms
403Order is already fully refunded.0never seen
422Validation Error5578ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized132ms
Examples1 / 1 used
Body: application/json
falseRefundCreate.revoke_benefits
storefronts 3 operations 3 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters1 of 1 keywords covered
product_id1 / 1
#validinvalidschema
1203n/a{
2203n/a "type": "string"
3203n/a}
Responses1 of 3 documented received
codedescriptionhitsavg
200Successful Response1713ms
404Organization not found.0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error321255ms
Path Parameters1 of 1 keywords covered
subscription_id1 / 1
#validinvalidschema
194n/a{
294n/a "type": "string"
394n/a}
Responses1 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Organization not found.503ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error441558ms
Path Parameters1 of 1 keywords covered
slug1 / 1
#validinvalidschema
15n/a{
25n/a "type": "string"
35n/a}
Responses1 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Organization not found.54ms
422Validation Error0never seen
subscriptions 7 operations 1 covered 6 partial 0 uncovered 0 not measured 72% #
Query Parameters32 of 62 keywords covered
organization_id2 / 7
#validinvalidschema
16100{
26100 "anyOf": [
30610 {
400 "format": "uuid4",
50n/a "type": "string",
60610 },
76100 {
86100 "items": {
96100 "format": "uuid4",
10610n/a "type": "string",
116100 },
126100 "type": "array"
136100 },
140610 {
150610 "type": "null"
160610 }
176100 ],
186100}
product_id3 / 7
15025{
25025 "anyOf": [
30507 {
400 "format": "uuid4",
50n/a "type": "string",
60507 },
75025 {
85025 "items": {
95200 "format": "uuid4",
10520n/a "type": "string",
115025 },
125070 "type": "array"
135025 },
140507 {
150507 "type": "null"
160507 }
175025 ],
185025}
customer_id3 / 7
12014{
22014 "anyOf": [
30205 {
400 "format": "uuid4",
50n/a "type": "string"
60205 },
72014 {
82014 "items": {
95650 "format": "uuid4",
10565n/a "type": "string"
112014 },
122050 "type": "array"
132014 },
140205 {
150205 "type": "null"
160205 }
172014 ],
182014}
external_customer_id3 / 5
196n/a{
296n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
69693 {
796n/a "items": {
8312n/a "type": "string"
996n/a },
101890 "type": "array"
119693 },
120189 {
130189 "type": "null"
140189 }
1596n/a ],
1696n/a}
discount_id3 / 7
11824{
21824 "anyOf": [
30186 {
400 "format": "uuid4",
50n/a "type": "string",
60186 },
71824 {
81824 "items": {
93050 "format": "uuid4",
10305n/a "type": "string",
111824 },
121860 "type": "array"
131824 },
140186 {
150186 "type": "null"
160186 }
171824 ],
181824}
active3 / 3
11769{
21769 "anyOf": [
317213 {
417213 "type": "boolean"
517213 },
64181 {
74181 "type": "null"
84181 }
91769 ],
101769}
cancel_at_period_end3 / 3
11886{
21886 "anyOf": [
318311 {
418311 "type": "boolean"
518311 },
65189 {
75189 "type": "null"
85189 }
91886 ],
101886}
page2 / 2
124617{
22462 "exclusiveMinimum": 0,
324815 "type": "integer"
424617}
limit2 / 2
123717{
22372 "exclusiveMinimum": 0,
323915 "type": "integer"
423717}
sorting4 / 6
114513{
214513 "anyOf": [
314513 {
414513 "items": {
543515 "$ref": "#/components/schemas/SubscriptionSortProperty"
614513 },
71580 "type": "array"
814513 },
90158 {
100158 "type": "null"
110158 }
1214513 ],
1314513}
Referenced Components (1)3 of 3 keywords
SubscriptionSortProperty3 of 3 keywords
143515{
243515 "enum": [
328n/a "customer",
420n/a "-customer",
525n/a "status",
628n/a "-status",
733n/a "started_at",
892n/a "-started_at",
926n/a "current_period_end",
1020n/a "-current_period_end",
1147n/a "amount",
1233n/a "-amount",
1316n/a "product",
1419n/a "-product",
1529n/a "discount",
1619n/a "-discount"
1743515 ],
18437n/a "type": "string"
1943515}
metadata4 / 13
MetadataQuery
1480{
2480 "anyOf": [
3480 {
4480 "additionalProperties": {
51330 "anyOf": [
69142 {
79142 "type": "string"
89142 },
90133 {
100133 "type": "integer"
110133 },
120133 {
130133 "type": "boolean"
140133 },
154291 {
16420 "items": {
172470 "type": "string"
18420 },
194291 "type": "array"
204291 },
210133 {
22042 "items": {
230247 "type": "integer"
24042 },
254291 "type": "array"
260133 },
270133 {
28042 "items": {
290247 "type": "boolean"
30042 },
314291 "type": "array"
320133 }
331330 ]
34480 },
35480 "type": "object"
36480 },
37048 {
38048 "type": "null"
39048 }
40480 ],
41480}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response42610ms
422Validation Error715ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1043ms
500Internal Server Error91494ms
Examples3 / 5 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-started_at" ]sorting
Body33 of 38 keywords covered
application/json33 / 38
#validinvalidschema
137978{
237978 "anyOf": [
3217240 {
4217240 "$ref": "#/components/schemas/SubscriptionCreateCustomer"
5217240 },
6162295 {
7162295 "$ref": "#/components/schemas/SubscriptionCreateExternalCustomer"
8162295 }
937978 ],
1037978}
Referenced Components (2)36 of 41 keywords
SubscriptionCreateCustomer18 of 21 keywords
1217240{
238750 "properties": {
32435 "customer_id": {
42430 "format": "uuid4",
52435 "type": "string"
62435 },
716028 "metadata": {
810815 "additionalProperties": {
931648 "anyOf": [
10108256 {
111184 "maxLength": 500,
1211210 "minLength": 1,
13122242 "type": "string"
14108256 },
1564300 {
1664300 "type": "integer"
1764300 },
1892272 {
1992272 "type": "number"
2092272 },
21116248 {
22116248 "type": "boolean"
23116248 }
2431648 ]
2510815 },
261750 "maxProperties": 50,
271194 "propertyNames": {
283622 "maxLength": 40,
293622 "minLength": 1
301194 },
3117513 "type": "object"
3216028 },
3341718 "product_id": {
344170 "format": "uuid4",
3541718 "type": "string"
3641718 }
3738750 },
38247192 "required": [
394354 "product_id",
40248191 "customer_id"
41247192 ],
4243918 "type": "object"
43217240}
SubscriptionCreateExternalCustomer18 of 20 keywords
1162295{
238950 "properties": {
31846 "external_customer_id": {
41846 "type": "string"
51846 },
616028 "metadata": {
710815 "additionalProperties": {
831648 "anyOf": [
9108256 {
101184 "maxLength": 500,
1111210 "minLength": 1,
12122242 "type": "string"
13108256 },
1464300 {
1564300 "type": "integer"
1664300 },
1792272 {
1892272 "type": "number"
1992272 },
20116248 {
21116248 "type": "boolean"
22116248 }
2331648 ]
2410815 },
251750 "maxProperties": 50,
261194 "propertyNames": {
273622 "maxLength": 40,
283622 "minLength": 1
291194 },
3017513 "type": "object"
3116028 },
3241718 "product_id": {
334170 "format": "uuid4",
3441718 "type": "string"
3541718 }
3638950 },
37187252 "required": [
384354 "product_id",
39190249 "external_customer_id"
40187252 ],
4143918 "type": "object"
42162295}
Responses1 of 2 documented received
codedescriptionhitsavg
201Subscription created.0never seen
422Validation Error5137ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1004ms
401Unauthorized172ms
500Internal Server Error41512ms
Examples3 / 3 used
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 Parameters2 of 7 keywords covered
organization_id2 / 7
#validinvalidschema
14260{
24260 "anyOf": [
30426 {
400 "format": "uuid4",
50n/a "type": "string",
60426 },
74260 {
84260 "items": {
94260 "format": "uuid4",
10426n/a "type": "string",
114260 },
124260 "type": "array"
134260 },
140426 {
150426 "type": "null"
160426 }
174260 ],
184260}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response2377ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1893ms
Examples0 / 2 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
12320{
22320 "format": "uuid4",
3232n/a "type": "string"
42320}
Responses1 of 5 documented received
codedescriptionhitsavg
200Subscription revoked.0never seen
403This subscription is already revoked.0never seen
404Subscription not found.2228ms
409Subscription is pending an update.0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized102ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13142{
23142 "format": "uuid4",
3316n/a "type": "string"
43142}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Subscription not found.3009ms
422Validation Error25ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized143ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
15656{
25656 "format": "uuid4",
3571n/a "type": "string"
45656}
Body67 of 69 keywords covered
application/json67 / 69
SubscriptionUpdate
1384158{
2384158 "anyOf": [
3202340 {
4202340 "$ref": "#/components/schemas/SubscriptionUpdateProduct"
5202340 },
648494 {
748494 "$ref": "#/components/schemas/SubscriptionUpdateDiscount"
848494 },
914528 {
1014528 "$ref": "#/components/schemas/SubscriptionUpdateTrial"
1114528 },
1222520 {
1322520 "$ref": "#/components/schemas/SubscriptionUpdateSeats"
1422520 },
1522520 {
1622520 "$ref": "#/components/schemas/SubscriptionUpdateBillingPeriod"
1722520 },
1837505 {
1937505 "$ref": "#/components/schemas/SubscriptionCancel"
2037505 },
2139503 {
2239503 "$ref": "#/components/schemas/SubscriptionRevoke"
2339503 }
24384158 ]
25384158}
Referenced Components (9)83 of 85 keywords
CustomerCancellationReason3 of 3 keywords
168156{
268156 "enum": [
38n/a "customer_service",
48n/a "low_quality",
58n/a "missing_features",
68n/a "switched_service",
78n/a "too_complex",
810n/a "too_expensive",
910n/a "unused",
108n/a "other"
1168156 ],
1276148 "type": "string"
1368156}
SubscriptionCancel14 of 14 keywords
137505{
28246 "properties": {
35510 "cancel_at_period_end": {
45510 "type": "boolean"
55510 },
69316 "customer_cancellation_comment": {
79316 "anyOf": [
85104 {
95104 "type": "string"
105104 },
118821 {
128821 "type": "null"
138821 }
149316 ],
159316 },
169220 "customer_cancellation_reason": {
179220 "anyOf": [
183478 {
193478 "$ref": "#/components/schemas/CustomerCancellationReason"
203478 },
215854 {
225854 "type": "null"
235854 }
249220 ],
259220 }
268246 },
2765467 "required": [
2865467 "cancel_at_period_end"
2965467 ],
3053210 "type": "object"
3137505}
SubscriptionProrationBehavior3 of 3 keywords
134126{
234126 "enum": [
322n/a "invoice",
412n/a "prorate"
534126 ],
642118 "type": "string"
734126}
SubscriptionRevoke15 of 15 keywords
139503{
27848 "properties": {
39316 "customer_cancellation_comment": {
49316 "anyOf": [
55104 {
65104 "type": "string"
75104 },
88821 {
98821 "type": "null"
108821 }
119316 ],
129316 },
139220 "customer_cancellation_reason": {
149220 "anyOf": [
153478 {
163478 "$ref": "#/components/schemas/CustomerCancellationReason"
173478 },
185854 {
195854 "type": "null"
205854 }
219220 ],
229220 },
235712 "revoke": {
245712 "const": true,
255712 "type": "boolean"
265712 }
277848 },
2869463 "required": [
2969463 "revoke"
3069463 ],
3153210 "type": "object"
3239503}
SubscriptionUpdateBillingPeriod7 of 7 keywords
122520{
22212 "properties": {
32212 "current_billing_period_end": {
4222 "format": "date-time",
52410 "type": "string"
62212 }
72212 },
834498 "required": [
934498 "current_billing_period_end"
1034498 ],
1153210 "type": "object"
1222520}
SubscriptionUpdateDiscount9 of 10 keywords
148494{
2488 "properties": {
3488 "discount_id": {
4488 "anyOf": [
53026 {
6300 "format": "uuid4",
73026 "type": "string"
83026 },
91838 {
101838 "type": "null"
111838 }
12488 ],
13488 }
14488 },
1556476 "required": [
1656476 "discount_id"
1756476 ],
1853210 "type": "object"
1948494}
SubscriptionUpdateProduct10 of 11 keywords
1202340{
223030 "properties": {
321210 "product_id": {
42120 "format": "uuid4",
521210 "type": "string"
621210 },
76020 "proration_behavior": {
86020 "anyOf": [
91763 {
101763 "$ref": "#/components/schemas/SubscriptionProrationBehavior"
111763 },
124337 {
134337 "type": "null"
144337 }
156020 ],
166020 }
1723030 },
18222310 "required": [
19222310 "product_id"
20222310 ],
2153210 "type": "object"
22202340}
SubscriptionUpdateSeats11 of 11 keywords
122520{
25634 "properties": {
36020 "proration_behavior": {
46020 "anyOf": [
51763 {
61763 "$ref": "#/components/schemas/SubscriptionProrationBehavior"
71763 },
84337 {
94337 "type": "null"
104337 }
116020 ],
126020 },
133214 "seats": {
14324 "minimum": 1.0,
153412 "type": "integer"
163214 }
175634 },
1846486 "required": [
1946486 "seats"
2046486 ],
2153210 "type": "object"
2222520}
SubscriptionUpdateTrial11 of 11 keywords
114528{
21420 "properties": {
31420 "trial_end": {
41420 "anyOf": [
5925 {
6915 "format": "date-time",
72410 "type": "string"
8925 },
9529 {
10529 "const": "now",
112410 "type": "string"
12529 }
131420 ],
141420 }
151420 },
1634498 "required": [
1734498 "trial_end"
1834498 ],
1953210 "type": "object"
2014528}
Responses2 of 5 documented received
codedescriptionhitsavg
200Subscription updated.0never seen
403Subscription is already canceled or will be at the end of the period.0never seen
404Subscription not found.3427ms
409Subscription is pending an update.0never seen
422Validation Error2095ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized143ms
400Bad Request65ms
Examples1 / 1 used
Body: application/json
"d8dd2de1-21b7-4a41-8bc3-ce909c0cfe23"SubscriptionUpdateProduct.product_id.examples[0]
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13210{
23210 "format": "uuid4",
3321n/a "type": "string"
43210}
Responses1 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Subscription not found.2979ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized243ms
transactions 3 operations 2 covered 1 partial 0 uncovered 0 not measured 94% #
Query Parameters2 of 2 keywords covered
transaction_id2 / 2
#validinvalidschema
15378{
25378 "format": "uuid4",
3545n/a "type": "string"
45378}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error96ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found50811ms
401Unauthorized293ms
Query Parameters30 of 32 keywords covered
type5 / 5
#validinvalidschema
110820{
210820 "anyOf": [
39830 {
49830 "$ref": "#/components/schemas/TransactionType"
59830 },
610118 {
710118 "type": "null"
810118 }
910820 ],
1010820}
Referenced Components (1)3 of 3 keywords
TransactionType3 of 3 keywords
19830{
29830 "enum": [
356n/a "payment",
47n/a "processor_fee",
58n/a "refund",
65n/a "refund_reversal",
74n/a "dispute",
88n/a "dispute_reversal",
94n/a "balance",
106n/a "payout"
119830 ],
12118n/a "type": "string"
139830}
account_id4 / 4
117611{
217611 "anyOf": [
317116 {
417111 "format": "uuid4",
5182n/a "type": "string"
617116 },
75182 {
85182 "type": "null"
95182 }
1017611 ],
1117611}
payment_customer_id4 / 4
112411{
212411 "anyOf": [
311817 {
411811 "format": "uuid4",
5129n/a "type": "string"
611817 },
76129 {
86129 "type": "null"
96129 }
1012411 ],
1112411}
payment_organization_id4 / 4
111919{
211919 "anyOf": [
311622 {
411619 "format": "uuid4",
5135n/a "type": "string"
611622 },
73135 {
83135 "type": "null"
93135 }
1011919 ],
1111919}
payment_user_id4 / 4
112612{
212612 "anyOf": [
312018 {
412012 "format": "uuid4",
5132n/a "type": "string"
612018 },
76132 {
86132 "type": "null"
96132 }
1012612 ],
1112612}
exclude_platform_fees1 / 1
116910{
216910 "type": "boolean"
316910}
page2 / 2
117313{
21732 "exclusiveMinimum": 0,
317511 "type": "integer"
417313}
limit2 / 2
116115{
21612 "exclusiveMinimum": 0,
316313 "type": "integer"
416115}
sorting4 / 6
19120{
29120 "anyOf": [
39120 {
49120 "items": {
524379 "$ref": "#/components/schemas/TransactionSortProperty"
69120 },
71110 "type": "array"
89120 },
90111 {
100111 "type": "null"
110111 }
129120 ],
139120}
Referenced Components (1)3 of 3 keywords
TransactionSortProperty3 of 3 keywords
124379{
224379 "enum": [
350n/a "created_at",
494n/a "-created_at",
542n/a "amount",
657n/a "-amount"
724379 ],
8299n/a "type": "string"
924379}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response24411ms
422Validation Error994ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized983ms
Examples4 / 4 used
Query
falseexclude_platform_fees
1page
10limit
[ "-created_at" ]sorting
Query Parameters2 of 2 keywords covered
account_id2 / 2
#validinvalidschema
131910{
231910 "format": "uuid4",
3329n/a "type": "string"
431910}
Responses1 of 2 documented received
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error118ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2998ms
401Unauthorized203ms
users 5 operations 4 covered 0 partial 1 uncovered 0 not measured 100% #
Expected Responses0 of 1 documented received
codedescriptionhitsavg
200Deletion result0never seen
Responses1 of 1 documented received
codedescriptionhitsavg
200Successful Response3485ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized2082ms
Responses0 of 1 documented received
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error19873ms
Path Parameters2 of 2 keywords covered
platform2 / 2
OAuthPlatform
#validinvalidschema
1165146{
2165146 "enum": [
328n/a "github",
418n/a "github_repository_benefit",
526n/a "google",
693n/a "apple"
7165146 ],
8311n/a "type": "string"
9165146}
Responses2 of 4 documented received
codedescriptionhitsavg
204Successful Response0never seen
400Cannot disconnect last authentication method0never seen
404OAuth account not found1375ms
422Validation Error1465ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized282ms
Responses1 of 1 documented received
codedescriptionhitsavg
200Successful Response1194ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1852ms
wallets 3 operations 0 covered 3 partial 0 uncovered 0 not measured 58% #
Query Parameters18 of 31 keywords covered
organization_id2 / 7
#validinvalidschema
17470{
27470 "anyOf": [
30747 {
400 "format": "uuid4",
50n/a "type": "string",
60747 },
77470 {
87470 "items": {
97470 "format": "uuid4",
10747n/a "type": "string",
117470 },
127470 "type": "array"
137470 },
140747 {
150747 "type": "null"
160747 }
177470 ],
187470}
type4 / 7
120032{
220032 "anyOf": [
30232 {
40232 "$ref": "#/components/schemas/WalletType"
50232 },
620032 {
720032 "items": {
8622147 "$ref": "#/components/schemas/WalletType"
920032 },
102320 "type": "array"
1120032 },
120232 {
130232 "type": "null"
140232 }
1520032 ],
1620032}
Referenced Components (1)3 of 3 keywords
WalletType3 of 3 keywords
1622379{
2622379 "enum": [
3332n/a "usage",
4290n/a "billing"
5622379 ],
6751n/a "type": "string"
7622379}
customer_id4 / 7
125413{
225413 "anyOf": [
30267 {
400 "format": "uuid4",
50n/a "type": "string"
60267 },
725413 {
825413 "items": {
966232 "format": "uuid4",
10694n/a "type": "string"
1125413 },
122670 "type": "array"
1325413 },
140267 {
150267 "type": "null"
160267 }
1725413 ],
1825413}
page2 / 2
130725{
23072 "exclusiveMinimum": 0,
330923 "type": "integer"
430725}
limit2 / 2
133826{
23382 "exclusiveMinimum": 0,
334024 "type": "integer"
433826}
sorting4 / 6
117216{
217216 "anyOf": [
317216 {
417216 "items": {
568118 "$ref": "#/components/schemas/WalletSortProperty"
617216 },
71880 "type": "array"
817216 },
90188 {
100188 "type": "null"
110188 }
1217216 ],
1317216}
Referenced Components (1)3 of 3 keywords
WalletSortProperty3 of 3 keywords
168118{
268118 "enum": [
3163n/a "created_at",
4187n/a "-created_at",
5144n/a "balance",
6187n/a "-balance"
768118 ],
8685n/a "type": "string"
968118}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response57411ms
422Validation Error746ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized903ms
500Internal Server Error91454ms
Examples3 / 5 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
[ "-created_at" ]sorting
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13040{
23040 "format": "uuid4",
3304n/a "type": "string"
43040}
Responses1 of 3 documented received
codedescriptionhitsavg
200Successful Response0never seen
404Wallet not found.2719ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized333ms
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
15890{
25890 "format": "uuid4",
3589n/a "type": "string"
45890}
Body6 of 6 keywords covered
application/json6 / 6
WalletTopUpCreate
148735{
249423 "properties": {
349417 "amount": {
449417 "type": "integer"
549417 },
649917 "currency": {
74992 "pattern": "usd",
850115 "type": "string"
949917 }
1049423 },
115107 "required": [
125116 "amount",
135161 "currency"
145107 ],
155175 "type": "object"
1648735}
Responses3 of 6 documented received
codedescriptionhitsavg
200Successful Response0never seen
201Wallet topped up successfully.0never seen
400The payment request failed.395ms
402No payment method available.0never seen
404Wallet not found.4767ms
422Validation Error625ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized123ms
Examples1 / 1 used
Body: application/json
2000WalletTopUpCreate.amount.examples[0]
webhooks 8 operations 3 covered 5 partial 0 uncovered 0 not measured 85% #
Query Parameters16 of 19 keywords covered
endpoint_id4 / 7
#validinvalidschema
14165{
24165 "anyOf": [
30421 {
400 "format": "uuid4",
50n/a "type": "string"
60421 },
74165 {
84165 "items": {
94651 "format": "uuid4",
10466n/a "type": "string"
114165 },
124210 "type": "array"
134165 },
140421 {
150421 "type": "null"
160421 }
174165 ],
184165}
start_timestamp4 / 4
117516{
217516 "anyOf": [
317120 {
417116 "format": "date-time",
5187n/a "type": "string"
617120 },
74187 {
84187 "type": "null"
94187 }
1017516 ],
1117516}
end_timestamp4 / 4
120018{
220018 "anyOf": [
319622 {
419618 "format": "date-time",
5214n/a "type": "string"
619622 },
74214 {
84214 "type": "null"
94214 }
1020018 ],
1120018}
page2 / 2
119521{
21952 "exclusiveMinimum": 0,
319719 "type": "integer"
419521}
limit2 / 2
122020{
22202 "exclusiveMinimum": 0,
322218 "type": "integer"
422020}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response4738ms
422Validation Error525ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized393ms
500Internal Server Error111641ms
Examples2 / 2 used
Query
1page
10limit
Query Parameters6 of 11 keywords covered
organization_id2 / 7
#validinvalidschema
16740{
26740 "anyOf": [
30674 {
400 "format": "uuid4",
50n/a "type": "string",
60674 },
76740 {
86740 "items": {
96740 "format": "uuid4",
10674n/a "type": "string",
116740 },
126740 "type": "array"
136740 },
140674 {
150674 "type": "null"
160674 }
176740 ],
186740}
page2 / 2
122253{
222213 "exclusiveMinimum": 0,
323540 "type": "integer"
422253}
limit2 / 2
125847{
225818 "exclusiveMinimum": 0,
327629 "type": "integer"
425847}
Responses2 of 2 documented received
codedescriptionhitsavg
200Successful Response4947ms
422Validation Error595ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1093ms
500Internal Server Error121361ms
Examples2 / 4 used
Query
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"organization_id
1page
10limit
Body22 of 22 keywords covered
application/json22 / 22
WebhookEndpointCreate
#validinvalidschema
1526116{
253894 "properties": {
360723 "events": {
460713 "items": {
5175313 "$ref": "#/components/schemas/WebhookEventType"
660713 },
762010 "type": "array"
860723 },
961119 "format": {
1061119 "$ref": "#/components/schemas/WebhookFormat",
1161119 },
126209 "organization_id": {
136209 "anyOf": [
1461811 {
156181 "format": "uuid4",
1661910 "type": "string",
1761811 },
182627 {
192627 "type": "null"
202627 }
216209 ],
226209 },
2336614 "secret": {
2436614 "anyOf": [
2532555 {
263255 "minLength": 32,
2733050 "type": "string"
2832555 },
2941339 {
3041339 "type": "null"
3141339 }
3236614 ],
3336614 },
3459529 "url": {
3560410 "format": "uri",
366059 "maxLength": 2083,
376068 "minLength": 1,
3861410 "type": "string"
3959529 }
4053894 },
4162012 "required": [
426248 "url",
436302 "format",
446302 "events"
4562012 ],
4663210 "type": "object"
47526116}
Referenced Components (2)6 of 6 keywords
WebhookEventType3 of 3 keywords
1175313{
2175313 "enum": [
335n/a "checkout.created",
438n/a "checkout.updated",
543n/a "customer.created",
642n/a "customer.updated",
742n/a "customer.deleted",
870n/a "customer.state_changed",
955n/a "customer_seat.assigned",
1059n/a "customer_seat.claimed",
1162n/a "customer_seat.revoked",
1258n/a "order.created",
1347n/a "order.updated",
1466n/a "order.paid",
1569n/a "order.refunded",
16158n/a "subscription.created",
1770n/a "subscription.updated",
1869n/a "subscription.active",
1961n/a "subscription.canceled",
2040n/a "subscription.uncanceled",
2172n/a "subscription.revoked",
2259n/a "refund.created",
2333n/a "refund.updated",
2441n/a "product.created",
2577n/a "product.updated",
2643n/a "benefit.created",
2789n/a "benefit.updated",
2882n/a "benefit_grant.created",
2972n/a "benefit_grant.cycled",
3034n/a "benefit_grant.updated",
3137n/a "benefit_grant.revoked",
3230n/a "organization.updated"
33175313 ],
34175610 "type": "string"
35175313}
WebhookFormat3 of 3 keywords
161119{
261119 "enum": [
3331n/a "raw",
488n/a "discord",
5192n/a "slack"
661119 ],
761614 "type": "string"
861119}
Responses2 of 2 documented received
codedescriptionhitsavg
201Webhook endpoint created.21015ms
422Validation Error4176ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized322ms
400Bad Request24ms
500Internal Server Error11775ms
Examples3 / 3 used
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 Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
1730{
2730 "format": "uuid4",
373n/a "type": "string"
4730}
Responses2 of 3 documented received
codedescriptionhitsavg
204Webhook endpoint deleted.349ms
404Webhook endpoint not found.256ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized142ms
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13090{
23090 "format": "uuid4",
3309n/a "type": "string"
43090}
Responses2 of 3 documented received
codedescriptionhitsavg
200Successful Response2667ms
404Webhook endpoint not found.178ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized263ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13514{
23514 "format": "uuid4",
3355n/a "type": "string"
43514}
Body26 of 26 keywords covered
application/json26 / 26
WebhookEndpointUpdate
128450{
211545 "properties": {
31354 "enabled": {
41354 "anyOf": [
533106 {
633106 "type": "boolean"
733106 },
810237 {
910237 "type": "null"
1010237 }
111354 ],
121354 },
1311522 "events": {
1411522 "anyOf": [
158948 {
168914 "items": {
1710585 "$ref": "#/components/schemas/WebhookEventType"
188914 },
1910334 "type": "array"
208948 },
2126111 {
2226111 "type": "null"
2326111 }
2411522 ],
2511522 },
261229 "format": {
271229 "anyOf": [
2830101 {
2930101 "$ref": "#/components/schemas/WebhookFormat",
3030101 },
319239 {
329239 "type": "null"
339239 }
341229 ]
351229 },
3612213 "secret": {
3712213 "anyOf": [
3811916 {
391192 "minLength": 32,
4012114 "type": "string"
4111916 },
423132 {
433132 "type": "null"
443132 }
4512213 ],
4612213 },
471248 "url": {
481248 "anyOf": [
4911814 {
501193 "format": "uri",
511211 "maxLength": 2083,
521211 "minLength": 1,
5312210 "type": "string"
5411814 },
556126 {
566126 "type": "null"
576126 }
581248 ],
591248 }
6011545 },
613295 "type": "object"
6228450}
Referenced Components (2)6 of 6 keywords
WebhookEventType3 of 3 keywords
110585{
210585 "enum": [
36n/a "checkout.created",
45n/a "checkout.updated",
52n/a "customer.created",
63n/a "customer.updated",
71n/a "customer.deleted",
85n/a "customer.state_changed",
93n/a "customer_seat.assigned",
107n/a "customer_seat.claimed",
115n/a "customer_seat.revoked",
122n/a "order.created",
136n/a "order.updated",
141n/a "order.paid",
154n/a "order.refunded",
1610n/a "subscription.created",
171n/a "subscription.updated",
184n/a "subscription.active",
191n/a "subscription.canceled",
205n/a "subscription.uncanceled",
211n/a "subscription.revoked",
224n/a "refund.created",
232n/a "refund.updated",
242n/a "product.created",
255n/a "product.updated",
266n/a "benefit.created",
271n/a "benefit.updated",
282n/a "benefit_grant.created",
294n/a "benefit_grant.cycled",
302n/a "benefit_grant.updated",
314n/a "benefit_grant.revoked",
321n/a "organization.updated"
3310585 ],
341837 "type": "string"
3510585}
WebhookFormat3 of 3 keywords
130101{
230101 "enum": [
38n/a "raw",
45n/a "discord",
517n/a "slack"
630101 ],
731100 "type": "string"
830101}
Responses3 of 3 documented received
codedescriptionhitsavg
200Webhook endpoint updated.1836ms
404Webhook endpoint not found.646ms
422Validation Error985ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized34ms
400Bad Request64ms
500Internal Server Error11653ms
Examples2 / 2 used
Body: application/json
"polar_whs_ovyN6cPrTv56AApvzCaJno08SSmGJmgbWilb33N2JuK"WebhookEndpointUpdate.secret.examples[0]
"https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0"WebhookEndpointUpdate.url.examples[0]
Path Parameters1 of 2 keywords covered
id1 / 2
#validinvalidschema
13090{
23090 "format": "uuid4",
3309n/a "type": "string"
43090}
Responses2 of 3 documented received
codedescriptionhitsavg
200Webhook endpoint secret reset.2488ms
404Webhook endpoint not found.396ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized222ms
Path Parameters2 of 2 keywords covered
id2 / 2
#validinvalidschema
13063{
23063 "format": "uuid4",
3309n/a "type": "string"
43063}
Responses2 of 3 documented received
codedescriptionhitsavg
202Webhook event re-delivery scheduled.0never seen
404Webhook event not found.2816ms
422Validation Error35ms
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized252ms
789 unmatched requests Not counted in coverage above
MethodHostPathReasonCount
GET0.0.0.0:44349/v1/customer-portal/license-keys/activatemethod not documented3
GET0.0.0.0:44349/v1/customer-portal/license-keys/deactivatemethod not documented3
GET0.0.0.0:44349/v1/customer-portal/license-keys/validatemethod not documented3
DELETE0.0.0.0:44349/v1/accountsmethod not documented1
DELETE0.0.0.0:44349/v1/accounts/searchmethod not documented1
DELETE0.0.0.0:44349/v1/accounts/{id}method not documented1
DELETE0.0.0.0:44349/v1/accounts/{id}/dashboard_linkmethod not documented1
DELETE0.0.0.0:44349/v1/accounts/{id}/onboarding_linkmethod not documented1
DELETE0.0.0.0:44349/v1/benefit-grants/method not documented1
DELETE0.0.0.0:44349/v1/benefits/method not documented1

... and 773 more groups