File size: 447,135 Bytes
1f10f31 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376 12377 12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475 12476 12477 12478 12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505 12506 12507 12508 12509 12510 12511 12512 12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 12550 12551 12552 12553 12554 12555 12556 12557 12558 12559 12560 12561 12562 12563 12564 12565 12566 12567 12568 12569 12570 12571 12572 12573 12574 12575 12576 12577 12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615 12616 12617 12618 12619 12620 12621 12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649 12650 12651 12652 12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700 12701 12702 12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725 12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742 12743 12744 12745 12746 12747 12748 12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759 12760 12761 12762 12763 12764 12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808 12809 12810 12811 12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866 12867 12868 12869 12870 12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891 12892 12893 12894 12895 12896 12897 12898 12899 12900 12901 12902 12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921 12922 12923 12924 12925 12926 12927 12928 12929 12930 12931 12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942 12943 12944 12945 12946 12947 12948 12949 12950 12951 12952 12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989 12990 12991 12992 12993 12994 12995 12996 12997 12998 12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014 13015 13016 13017 13018 13019 13020 13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038 13039 13040 13041 13042 13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054 13055 13056 13057 13058 13059 13060 13061 13062 13063 13064 13065 13066 13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098 13099 13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111 13112 13113 13114 13115 13116 13117 13118 13119 13120 13121 13122 13123 13124 13125 13126 13127 13128 13129 13130 13131 13132 13133 13134 13135 13136 13137 13138 13139 13140 13141 13142 13143 13144 13145 13146 13147 13148 13149 13150 13151 13152 13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164 13165 13166 13167 13168 13169 13170 13171 13172 13173 13174 13175 13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 13204 13205 13206 13207 13208 13209 13210 13211 13212 13213 13214 13215 13216 13217 13218 13219 13220 13221 13222 13223 13224 13225 13226 13227 13228 13229 13230 13231 13232 13233 13234 13235 13236 13237 13238 13239 13240 13241 13242 13243 13244 13245 13246 13247 13248 13249 13250 13251 13252 13253 13254 13255 13256 13257 13258 13259 13260 13261 13262 13263 13264 13265 13266 13267 13268 13269 13270 13271 13272 13273 13274 13275 13276 13277 13278 13279 13280 13281 13282 13283 13284 13285 13286 13287 13288 13289 13290 13291 13292 13293 13294 13295 13296 13297 13298 13299 13300 13301 13302 13303 13304 13305 13306 13307 13308 13309 13310 13311 13312 13313 13314 13315 13316 13317 13318 13319 13320 13321 13322 13323 13324 13325 13326 13327 13328 13329 13330 13331 13332 13333 13334 13335 13336 13337 13338 13339 13340 13341 13342 13343 13344 13345 13346 13347 13348 13349 13350 13351 13352 13353 13354 13355 13356 13357 13358 13359 13360 13361 13362 13363 13364 13365 13366 13367 13368 13369 13370 13371 13372 13373 13374 13375 13376 13377 13378 13379 13380 13381 13382 13383 13384 13385 13386 13387 | openapi: 3.0.0
info:
title: OpenMeter and Konnect Metering & Billing API
version: 0.0.1
description: |-
OpenMeter is a cloud native usage metering and billing service. The API allows
you to ingest events, query meter usage, and manage resources.
servers:
- url: http://localhost:{port}/api/v3
description: Local
variables:
port:
default: '8888'
- url: https://{region}.api.konghq.com/v3
description: Production region
variables:
region:
default: us
enum:
- us
- eu
- au
- me
- in
- url: https://openmeter.cloud/api/v3
description: OpenMeter Cloud
variables: {}
tags:
- name: OpenMeter Governance
description: Governance evaluation of customers to check their feature access.
- name: OpenMeter Defaults
description: Organization-level default configuration.
- name: OpenMeter Product Catalog
description: Product catalog manages plans, add-ons, and their associations for subscription-based billing.
- name: OpenMeter LLM Cost
description: LLM cost database providing normalized pricing data for language models across providers. Prices are synced from multiple external sources and auto-confirmed when they agree.
- name: OpenMeter Features
description: Features represent product capabilities backed by meters, with optional per-unit cost configuration.
- name: OpenMeter Tax
description: Tax codes are used to calculate taxes for customers.
- name: OpenMeter Currencies
description: Currencies and cost bases for customers.
- name: OpenMeter Billing Settings
description: Billing settings manages the billing profiles and invoices for customers.
- name: OpenMeter Apps
description: Apps enable you to extend and customize billing and usage workflows by integrating with external systems and services. Apps can automate and enhance your billing ecosystem by supporting capabilities such as synchronizing usage data with third-party platforms, calculating taxes, generating and delivering invoices, handling payment collection, and other billing-related tasks.
- name: OpenMeter Entitlements
description: Entitlements are used to control access to features for customers.
- name: OpenMeter Subscriptions
description: Subscriptions are used to track usage of your product or service. Subscriptions can be individuals or organizations that can subscribe to plans and have access to features.
- name: OpenMeter Customers
description: Customers are used to track usage of your product or service. Customers can be individuals or organizations that can subscribe to plans and have access to features.
- name: Metering Events
description: Metering events are used to track usage of your product or service. Events are processed asynchronously by the meters, so they may not be immediately available for querying.
- name: Meters
description: Meters specify how to aggregate events for billing and analytics purposes. Meters can be configured with multiple aggregation methods and groupings. Multiple meters can be created for the same event type, enabling flexible metering scenarios.
paths:
/openmeter/addons:
get:
operationId: list-addons
summary: List add-ons
description: List all add-ons.
parameters:
- $ref: '#/components/parameters/PagePaginationQuery'
- name: sort
in: query
required: false
description: |-
Sort add-ons returned in the response. Supported sort attributes are:
- `id`
- `key`
- `name`
- `created_at` (default)
- `updated_at`
The `asc` suffix is optional as the default sort order is ascending. The `desc`
suffix is used to specify a descending order.
schema:
$ref: '#/components/schemas/SortQuery'
explode: false
style: form
- name: filter
in: query
required: false
description: Filter add-ons returned in the response.
schema:
$ref: '#/components/schemas/ListAddonsParamsFilter'
style: deepObject
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/AddonPagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Product Catalog
x-unstable: true
post:
operationId: create-addon
summary: Create add-on
description: Create a new add-on.
responses:
'201':
description: Addon created response.
content:
application/json:
schema:
$ref: '#/components/schemas/Addon'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Product Catalog
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAddonRequest'
x-unstable: true
/openmeter/addons/{addonId}:
put:
operationId: update-addon
summary: Update add-on
description: Update an add-on by id.
parameters:
- name: addonId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Addon upsert response.
content:
application/json:
schema:
$ref: '#/components/schemas/Addon'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'410':
$ref: '#/components/responses/Gone'
tags:
- OpenMeter Product Catalog
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertAddonRequest'
x-unstable: true
get:
operationId: get-addon
summary: Get add-on
description: Get add-on by id.
parameters:
- name: addonId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Addon response.
content:
application/json:
schema:
$ref: '#/components/schemas/Addon'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'410':
$ref: '#/components/responses/Gone'
tags:
- OpenMeter Product Catalog
x-unstable: true
delete:
operationId: delete-addon
summary: Soft delete add-on
description: Soft delete add-on by id.
parameters:
- name: addonId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'204':
description: Deleted response.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Product Catalog
x-unstable: true
/openmeter/addons/{addonId}/archive:
post:
operationId: archive-addon
summary: Archive add-on version
description: Archive an add-on version.
parameters:
- name: addonId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Addon updated response.
content:
application/json:
schema:
$ref: '#/components/schemas/Addon'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Product Catalog
x-unstable: true
/openmeter/addons/{addonId}/publish:
post:
operationId: publish-addon
summary: Publish add-on version
description: Publish an add-on version.
parameters:
- name: addonId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Addon updated response.
content:
application/json:
schema:
$ref: '#/components/schemas/Addon'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Product Catalog
x-unstable: true
/openmeter/app-catalog:
get:
operationId: list-app-catalog
summary: List app catalog
description: List available apps.
parameters:
- $ref: '#/components/parameters/PagePaginationQuery'
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/AppCatalogItemPagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Apps
/openmeter/app-catalog/install:
post:
operationId: install-app
summary: Install app from the catalog
description: Install an app from the catalog.
responses:
'201':
description: InstallAppResponse created response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingInstallAppResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Apps
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BillingInstallAppRequest'
/openmeter/app-catalog/{appType}:
get:
operationId: get-app-catalog-item
summary: Get app catalog item by type
description: Get an app catalog item by type.
parameters:
- name: appType
in: path
required: true
schema:
$ref: '#/components/schemas/BillingAppType'
responses:
'200':
description: AppCatalogItem response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingAppCatalogItem'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Apps
/openmeter/apps:
get:
operationId: list-apps
summary: List apps
description: List installed apps.
parameters:
- $ref: '#/components/parameters/PagePaginationQuery'
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/AppPagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Apps
/openmeter/apps/{appId}:
get:
operationId: get-app
summary: Get app
description: Get an installed app.
parameters:
- name: appId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: App response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingApp'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Apps
/openmeter/billing/invoices:
get:
operationId: list-invoices
summary: List billing invoices
description: |-
List billing invoices.
Returns a page of invoices. Gathering invoices are never included. Use `filter`
to narrow by status, customer, dates, or service period start. Use `sort` to
control ordering.
parameters:
- $ref: '#/components/parameters/PagePaginationQuery'
- name: sort
in: query
required: false
description: |-
Sort invoices returned in the response. Supported sort attributes:
- `issued_at`
- `created_at` (default)
- `service_period_start`
The `asc` suffix is optional as the default sort order is ascending. The `desc`
suffix is used to specify a descending order.
schema:
$ref: '#/components/schemas/SortQuery'
explode: false
style: form
- name: filter
in: query
required: false
description: |-
Filter invoices returned in the response.
Examples:
- `filter[status][oeq]=draft,issued`
- `filter[customer_id]=01KPDB8K...`
- `filter[issued_at][gte]=2024-01-01T00:00:00Z`
schema:
$ref: '#/components/schemas/ListInvoicesParamsFilter'
style: deepObject
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/InvoicePagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Billing Settings
x-private: true
x-internal: true
x-unstable: true
/openmeter/billing/invoices/{invoiceId}:
get:
operationId: get-invoice
summary: Get a billing invoice
description: |-
Get a billing invoice by ID.
Returns the full invoice resource including line items, status details, totals,
and workflow configuration snapshot.
parameters:
- name: invoiceId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Invoice response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingInvoice'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Billing Settings
x-private: true
x-internal: true
x-unstable: true
put:
operationId: update-invoice
summary: Update a billing invoice
description: |-
Update a billing invoice.
Only the mutable fields of the invoice can be edited: description, labels,
supplier, customer, workflow settings, and top-level lines. Top-level lines are
matched by `id`; lines without an `id` are created, and existing lines omitted
from `lines` are deleted. Detailed (child) lines are always computed and cannot
be edited directly. Only invoices in draft status can be updated.
parameters:
- name: invoiceId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Invoice updated response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingInvoice'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Billing Settings
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateInvoiceRequest'
x-private: true
x-internal: true
x-unstable: true
delete:
operationId: delete-invoice
summary: Delete a billing invoice
description: |-
Delete a billing invoice.
Only standard invoices in draft status can be deleted. Deleting an invoice will
also delete all associated line items and workflow configuration.
parameters:
- name: invoiceId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'204':
description: Deleted response.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Billing Settings
x-private: true
x-internal: true
x-unstable: true
/openmeter/billing/invoices/{invoiceId}/advance:
post:
operationId: advance-invoice
summary: Advance billing invoice's next status
description: |-
Advance a billing invoice.
Advances the invoice to the next workflow state. The next state is determined by
the invoice's current status and workflow configuration. Only invoices in draft
or issued status can be advanced.
parameters:
- name: invoiceId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: The updated invoice after advancing to the next state.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingInvoice'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Billing Settings
x-private: true
x-internal: true
x-unstable: true
/openmeter/billing/invoices/{invoiceId}/approve:
post:
operationId: approve-invoice
summary: Send the invoice to the customer
description: |-
Approve a billing invoice.
This call instantly sends the invoice to the customer using the configured
billing profile app.
This call is valid in two invoice statuses:
- draft: the invoice will be sent to the customer, the invoice state becomes
issued
- manual_approval_needed: the invoice will be sent to the customer, the invoice
state becomes issued
parameters:
- name: invoiceId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: The updated invoice after sending to the customer.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingInvoice'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Billing Settings
x-private: true
x-internal: true
x-unstable: true
/openmeter/billing/invoices/{invoiceId}/retry:
post:
operationId: retry-invoice
summary: Retry advancing the invoice after a failed attempt
description: |-
Retry sending a billing invoice.
Retry advancing the invoice after a failed attempt.
The action can be called when the invoice's statusDetails' actions field contain
the "retry" action.
parameters:
- name: invoiceId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: The updated invoice after retrying the action.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingInvoice'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Billing Settings
x-private: true
x-internal: true
x-unstable: true
/openmeter/billing/invoices/{invoiceId}/snapshot-quantities:
post:
operationId: snapshot-quantities-invoice
summary: Snapshot quantities for usage based line items
description: |-
Snapshot quantities for usage-based line items.
This call will snapshot the quantities for all usage based line items in the
invoice.
This call is only valid in draft.waiting_for_collection status, where the
collection period can be skipped using this action.
parameters:
- name: invoiceId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: |-
The updated invoice with the snapshot quantities for usage based line
items.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingInvoice'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Billing Settings
x-private: true
x-internal: true
x-unstable: true
/openmeter/currencies:
get:
operationId: list-currencies
summary: List currencies
description: List currencies supported by the billing system.
parameters:
- $ref: '#/components/parameters/PagePaginationQuery'
- name: sort
in: query
required: false
description: |-
Sort currencies returned in the response. Supported sort attributes are:
- `code` (default)
- `name`
The `asc` suffix is optional as the default sort order is ascending. The `desc`
suffix is used to specify a descending order.
schema:
$ref: '#/components/schemas/SortQuery'
explode: false
style: form
- name: filter
in: query
required: false
description: |-
Filter currencies returned in the response.
To filter currencies by type add the following query param: filter[type]=custom
schema:
$ref: '#/components/schemas/ListCurrenciesParamsFilter'
style: deepObject
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/CurrencyPagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Currencies
x-internal: true
x-unstable: true
/openmeter/currencies/custom:
post:
operationId: create-custom-currency
summary: Create custom currency
description: |-
Create a custom currency. This operation allows defining your own custom
currency for billing purposes.
responses:
'201':
description: CurrencyCustom created response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingCurrencyCustom'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Currencies
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCurrencyCustomRequest'
x-internal: true
x-unstable: true
/openmeter/currencies/custom/{currencyId}/cost-bases:
get:
operationId: list-cost-bases
summary: List cost bases
description: |-
List cost bases for a currency. For custom currencies, there can be multiple
cost bases with different `effective_from` dates.
parameters:
- name: currencyId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
- name: filter
in: query
required: false
description: |-
Filter cost bases returned in the response.
To filter cost bases by fiat currency code add the following query param:
filter[fiat_code]=USD
schema:
$ref: '#/components/schemas/ListCostBasesParamsFilter'
style: deepObject
- $ref: '#/components/parameters/PagePaginationQuery'
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/CostBasisPagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Currencies
x-internal: true
x-unstable: true
post:
operationId: create-cost-basis
summary: Create cost basis
description: Create a cost basis for a currency.
parameters:
- name: currencyId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'201':
description: CostBasis created response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingCostBasis'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Currencies
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCostBasisRequest'
x-internal: true
x-unstable: true
/openmeter/customers:
post:
operationId: create-customer
summary: Create customer
responses:
'201':
description: Customer created response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingCustomer'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Customers
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCustomerRequest'
get:
operationId: list-customers
summary: List customers
parameters:
- $ref: '#/components/parameters/PagePaginationQuery'
- name: sort
in: query
required: false
description: |-
Sort customers returned in the response. Supported sort attributes are:
- `id`
- `name` (default)
- `created_at`
The `asc` suffix is optional as the default sort order is ascending. The `desc`
suffix is used to specify a descending order.
schema:
$ref: '#/components/schemas/SortQuery'
explode: false
style: form
- name: filter
in: query
required: false
description: |-
Filter customers returned in the response.
To filter customers by key add the following query param: filter[key]=my-db-id
schema:
$ref: '#/components/schemas/ListCustomersParamsFilter'
style: deepObject
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerPagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Customers
/openmeter/customers/{customerId}:
get:
operationId: get-customer
summary: Get customer
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Customer response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingCustomer'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Customers
put:
operationId: upsert-customer
summary: Upsert customer
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Customer upsert response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingCustomer'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'410':
$ref: '#/components/responses/Gone'
tags:
- OpenMeter Customers
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertCustomerRequest'
delete:
operationId: delete-customer
summary: Delete customer
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'204':
description: Deleted response.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Customers
/openmeter/customers/{customerId}/billing:
get:
operationId: get-customer-billing
summary: Get customer billing data
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: CustomerBillingData response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingCustomerData'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Customers
put:
operationId: update-customer-billing
summary: Update customer billing data
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: CustomerBillingData upsert response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingCustomerData'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'410':
$ref: '#/components/responses/Gone'
tags:
- OpenMeter Customers
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertCustomerBillingDataRequest'
/openmeter/customers/{customerId}/billing/app-data:
put:
operationId: update-customer-billing-app-data
summary: Update customer billing app data
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: AppCustomerData upsert response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingAppCustomerData'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'410':
$ref: '#/components/responses/Gone'
tags:
- OpenMeter Customers
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertAppCustomerDataRequest'
/openmeter/customers/{customerId}/billing/stripe/checkout-sessions:
post:
operationId: create-customer-stripe-checkout-session
summary: Create Stripe Checkout Session
description: |-
Create a [Stripe Checkout Session](https://docs.stripe.com/payments/checkout)
for the customer.
Creates a Checkout Session for collecting payment method information from
customers. The session operates in "setup" mode, which collects payment details
without charging the customer immediately. The collected payment method can be
used for future subscription billing.
For hosted checkout sessions, redirect customers to the returned URL. For
embedded sessions, use the client_secret to initialize Stripe.js in your
application.
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'201':
description: CreateStripeCheckoutSessionResult created response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingAppStripeCreateCheckoutSessionResult'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'410':
$ref: '#/components/responses/Gone'
tags:
- OpenMeter Customers
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BillingCustomerStripeCreateCheckoutSessionRequest'
/openmeter/customers/{customerId}/billing/stripe/portal-sessions:
post:
operationId: create-customer-stripe-portal-session
summary: Create Stripe customer portal session
description: |-
Create Stripe Customer Portal Session.
Useful to redirect the customer to the Stripe Customer Portal to manage their
payment methods, change their billing address and access their invoice history.
Only returns URL if the customer billing profile is linked to a stripe app and
customer.
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'201':
description: CreateStripeCustomerPortalSessionResult created response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingAppStripeCreateCustomerPortalSessionResult'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'410':
$ref: '#/components/responses/Gone'
tags:
- OpenMeter Customers
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BillingCustomerStripeCreateCustomerPortalSessionRequest'
/openmeter/customers/{customerId}/charges:
get:
operationId: list-customer-charges
summary: List customer charges
description: |-
List customer charges.
Returns the customer's charges that are represented as either flat fee or
usage-based charges.
parameters:
- $ref: '#/components/parameters/PagePaginationQuery'
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
- name: sort
in: query
required: false
description: |-
Sort charges returned in the response.
Supported sort attributes are:
- `id`
- `created_at`
- `service_period.from`
- `billing_period.from`
schema:
$ref: '#/components/schemas/SortQuery'
explode: false
style: form
- name: filter
in: query
required: false
description: |-
Filter charges.
To filter charges by status add the following query param:
`filter[status][oeq]=created,active`
schema:
$ref: '#/components/schemas/ListChargesParamsFilter'
style: deepObject
- name: expand
in: query
required: false
description: |-
Expand full objects for referenced entities.
Supported values are:
- `real_time_usage`: Expand the charge's real-time usage.
schema:
type: array
items:
$ref: '#/components/schemas/BillingChargesExpand'
style: form
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/ChargePagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Customers
x-unstable: true
post:
operationId: create-customer-charges
summary: Create customer charge
description: Create customer charge.
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'201':
description: Charge created response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingCharge'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Customers
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateChargeRequest'
x-unstable: true
/openmeter/customers/{customerId}/credits/adjustments:
post:
operationId: create-credit-adjustment
summary: Create a credit adjustment
description: |-
A credit adjustment can be used to make manual adjustments to a customer's
credit balance.
Supported use-cases:
- Usage correction
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'201':
description: CreditAdjustment created response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingCreditAdjustment'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Customers
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCreditAdjustmentRequest'
x-unstable: true
/openmeter/customers/{customerId}/credits/balance:
get:
operationId: get-customer-credit-balance
summary: Get a customer's credit balance
description: Get a credit balance.
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
- name: timestamp
in: query
required: false
description: |-
Return the credit balance as of this timestamp.
Defaults to the current time.
schema:
$ref: '#/components/schemas/DateTime'
explode: false
style: form
- name: filter
in: query
required: false
schema:
$ref: '#/components/schemas/GetCreditBalanceParamsFilter'
style: deepObject
responses:
'200':
description: CreditBalances response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingCreditBalances'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Customers
x-unstable: true
/openmeter/customers/{customerId}/credits/grants:
post:
operationId: create-credit-grant
summary: Create a new credit grant
description: |-
Create a new credit grant. A credit grant represents an allocation of prepaid
credits to a customer.
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'201':
description: CreditGrant created response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingCreditGrant'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
tags:
- OpenMeter Customers
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCreditGrantRequest'
x-unstable: true
get:
operationId: list-credit-grants
summary: List credit grants
description: List credit grants.
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
- $ref: '#/components/parameters/PagePaginationQuery'
- name: filter
in: query
required: false
description: Filter credit grants returned in the response.
schema:
$ref: '#/components/schemas/ListCreditGrantsParamsFilter'
style: deepObject
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/CreditGrantPagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Customers
x-unstable: true
/openmeter/customers/{customerId}/credits/grants/{creditGrantId}:
get:
operationId: get-credit-grant
summary: Get a credit grant
description: Get a credit grant.
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
- name: creditGrantId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: CreditGrant response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingCreditGrant'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Customers
x-unstable: true
/openmeter/customers/{customerId}/credits/grants/{creditGrantId}/settlement/external:
post:
operationId: update-credit-grant-external-settlement
summary: Update credit grant external settlement status
description: |-
Update the payment settlement status of an externally funded credit grant.
Use this endpoint to synchronize the payment state of an external payment with
the system so that revenue recognition and credit availability work as expected.
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
- name: creditGrantId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: CreditGrant updated response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingCreditGrant'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Customers
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCreditGrantExternalSettlementRequest'
x-unstable: true
/openmeter/customers/{customerId}/credits/grants/{creditGrantId}/void:
post:
operationId: void-credit-grant
summary: Void credit grant
description: |-
Void a credit grant, forfeiting the remaining unused balance.
Voiding is a forward-looking, irreversible operation. Credits already consumed
by usage remain unaffected — only the remaining balance is forfeited. The grant
reads as `voided` status afterwards. Payment state is not adjusted when
`payment_adjustment` is `none`, so invoice-backed or externally collected
payments may still collect the original amount. Only `active` grants can be
voided; voiding a pending, expired, or fully consumed grant returns a conflict.
Retrying a successful void is an idempotent success.
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
- name: creditGrantId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: CreditGrant updated response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingCreditGrant'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
tags:
- OpenMeter Customers
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/VoidCreditGrantRequest'
x-unstable: true
/openmeter/customers/{customerId}/credits/transactions:
get:
operationId: list-credit-transactions
summary: List credit transactions
description: |-
List credit transactions for a customer.
Returns an immutable, chronological record of credit movements: funded credits
and consumed credits. Transactions are returned in reverse chronological order
by default.
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
- $ref: '#/components/parameters/CursorPaginationQuery'
- name: filter
in: query
required: false
description: Filter credit transactions returned in the response.
schema:
$ref: '#/components/schemas/ListCreditTransactionsParamsFilter'
style: deepObject
responses:
'200':
description: Cursor paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/CreditTransactionPaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Customers
x-unstable: true
/openmeter/customers/{customerId}/entitlement-access:
get:
operationId: list-customer-entitlement-access
summary: List customer entitlement access
parameters:
- name: customerId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: List the customer's active features and their access.
content:
application/json:
schema:
$ref: '#/components/schemas/ListCustomerEntitlementAccessResponseData'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Entitlements
/openmeter/defaults/tax-codes:
get:
operationId: get-organization-default-tax-codes
summary: Get organization default tax codes
responses:
'200':
description: OrganizationDefaultTaxCodes response.
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationDefaultTaxCodes'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Defaults
x-unstable: true
put:
operationId: update-organization-default-tax-codes
summary: Update organization default tax codes
responses:
'200':
description: OrganizationDefaultTaxCodes upsert response.
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationDefaultTaxCodes'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Defaults
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateOrganizationDefaultTaxCodesRequest'
x-unstable: true
/openmeter/events:
get:
operationId: list-metering-events
summary: List metering events
description: List ingested events.
parameters:
- $ref: '#/components/parameters/CursorPaginationQuery'
- name: filter
in: query
required: false
description: |-
Filter events returned in the response.
To filter events by subject add the following query param:
filter[subject][eq]=customer-1
schema:
$ref: '#/components/schemas/ListEventsParamsFilter'
style: deepObject
- name: sort
in: query
required: false
description: |-
Sort events returned in the response. Supported sort attributes are:
- `time` (default)
- `ingested_at`
- `stored_at`
When omitted, events are sorted by `time desc` (most recent first). When a sort
field is provided without a suffix, it sorts descending. Append the `asc` suffix
to sort ascending, or the `desc` suffix to sort descending.
schema:
$ref: '#/components/schemas/SortQuery'
explode: false
style: form
responses:
'200':
description: Cursor paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/IngestedEventPaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- Metering Events
x-unstable: true
post:
operationId: ingest-metering-events
description: Ingests an event or batch of events following the CloudEvents specification.
summary: Ingest metering events
responses:
'202':
description: The events have been ingested and are being processed asynchronously.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- Metering Events
requestBody:
required: true
content:
application/cloudevents+json:
schema:
$ref: '#/components/schemas/MeteringEvent'
application/cloudevents-batch+json:
schema:
type: array
items:
$ref: '#/components/schemas/MeteringEvent'
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/MeteringEvent'
- type: array
items:
$ref: '#/components/schemas/MeteringEvent'
/openmeter/features:
get:
operationId: list-features
summary: List features
description: List all features.
parameters:
- $ref: '#/components/parameters/PagePaginationQuery'
- name: sort
in: query
required: false
description: |-
Sort features returned in the response. Supported sort attributes are:
- `key`
- `name`
- `created_at` (default)
- `updated_at`
The `asc` suffix is optional as the default sort order is ascending. The `desc`
suffix is used to specify a descending order.
schema:
$ref: '#/components/schemas/SortQuery'
explode: false
style: form
- name: filter
in: query
required: false
description: |-
Filter features returned in the response.
To filter features by meter_id add the following query param:
filter[meter_id][oeq]=<id>
schema:
$ref: '#/components/schemas/ListFeatureParamsFilter'
style: deepObject
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/FeaturePagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Features
x-unstable: true
post:
operationId: create-feature
summary: Create feature
description: Create a feature.
responses:
'201':
description: Feature created response.
content:
application/json:
schema:
$ref: '#/components/schemas/Feature'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Features
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFeatureRequest'
x-unstable: true
/openmeter/features/{featureId}:
get:
operationId: get-feature
summary: Get feature
description: Get a feature by id.
parameters:
- name: featureId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Feature response.
content:
application/json:
schema:
$ref: '#/components/schemas/Feature'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'410':
$ref: '#/components/responses/Gone'
tags:
- OpenMeter Features
x-unstable: true
patch:
operationId: update-feature
summary: Update feature
description: Update a feature by id. Currently only the unit_cost field can be updated.
parameters:
- name: featureId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Feature updated response.
content:
application/json:
schema:
$ref: '#/components/schemas/Feature'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Features
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFeatureRequest'
x-unstable: true
delete:
operationId: delete-feature
summary: Delete feature
description: Delete a feature by id.
parameters:
- name: featureId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'204':
description: Deleted response.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Features
x-unstable: true
/openmeter/features/{featureId}/cost/query:
post:
operationId: query-feature-cost
summary: Query feature cost
description: Query the cost of a feature.
parameters:
- name: featureId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureCostQueryResult'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Features
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/MeterQueryRequest'
x-unstable: true
/openmeter/governance/query:
post:
operationId: query-governance-access
summary: Query governance access
description: |-
Query feature access for a list of customers.
The endpoint resolves each provided identifier to a customer and returns the
access status for the requested features, plus optional credit balance
availability.
_Designed to be called on a fixed refresh interval and the query response is
intended to be cached._
parameters:
- $ref: '#/components/parameters/CursorPaginationQuery'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/GovernanceQueryResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Governance
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GovernanceQueryRequest'
x-private: true
x-internal: true
x-unstable: true
/openmeter/llm-cost/overrides:
get:
operationId: list-llm-cost-overrides
summary: List LLM cost overrides
description: List per-namespace price overrides.
parameters:
- name: filter
in: query
required: false
schema:
$ref: '#/components/schemas/ListLLMCostPricesParamsFilter'
style: deepObject
- $ref: '#/components/parameters/PagePaginationQuery'
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/PricePagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter LLM Cost
x-unstable: true
post:
operationId: create-llm-cost-override
summary: Create LLM cost override
description: Create a per-namespace price override.
responses:
'201':
description: Price created response.
content:
application/json:
schema:
$ref: '#/components/schemas/LLMCostPrice'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter LLM Cost
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LLMCostOverrideCreate'
x-unstable: true
/openmeter/llm-cost/overrides/{priceId}:
delete:
operationId: delete-llm-cost-override
summary: Delete LLM cost override
description: Delete a per-namespace price override.
parameters:
- name: priceId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'204':
description: Deleted response.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter LLM Cost
x-unstable: true
/openmeter/llm-cost/prices:
get:
operationId: list-llm-cost-prices
summary: List LLM cost prices
description: List global LLM cost prices. Returns prices with overrides applied if any.
parameters:
- name: filter
in: query
required: false
description: Filter prices.
schema:
$ref: '#/components/schemas/ListLLMCostPricesParamsFilter'
style: deepObject
- name: sort
in: query
required: false
description: |-
Sort prices returned in the response. Supported sort attributes are:
- `id`
- `provider.id`
- `model.id` (default)
- `effective_from`
- `effective_to`
The `asc` suffix is optional as the default sort order is ascending. The `desc`
suffix is used to specify a descending order.
schema:
$ref: '#/components/schemas/SortQuery'
explode: false
style: form
- $ref: '#/components/parameters/PagePaginationQuery'
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/PricePagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter LLM Cost
x-unstable: true
/openmeter/llm-cost/prices/{priceId}:
get:
operationId: get-llm-cost-price
summary: Get LLM cost price
description: |-
Get a specific LLM cost price by ID. Returns the price with overrides applied if
any.
parameters:
- name: priceId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/LLMCostPrice'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter LLM Cost
x-unstable: true
/openmeter/meters:
post:
operationId: create-meter
summary: Create meter
description: Create a meter.
responses:
'201':
description: Meter created response.
content:
application/json:
schema:
$ref: '#/components/schemas/Meter'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- Meters
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMeterRequest'
get:
operationId: list-meters
summary: List meters
description: List meters.
parameters:
- $ref: '#/components/parameters/PagePaginationQuery'
- name: sort
in: query
required: false
description: |-
Sort meters returned in the response. Supported sort attributes are:
- `key`
- `name`
- `aggregation`
- `created_at` (default)
- `updated_at`
The `asc` suffix is optional as the default sort order is ascending. The `desc`
suffix is used to specify a descending order.
schema:
$ref: '#/components/schemas/SortQuery'
explode: false
style: form
- name: filter
in: query
required: false
description: |-
Filter meters returned in the response.
To filter meters by key add the following query param: filter[key]=my-meter-key
schema:
$ref: '#/components/schemas/ListMetersParamsFilter'
style: deepObject
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/MeterPagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- Meters
/openmeter/meters/{meterId}:
get:
operationId: get-meter
summary: Get meter
description: Get a meter by ID.
parameters:
- name: meterId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Meter response.
content:
application/json:
schema:
$ref: '#/components/schemas/Meter'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Meters
put:
operationId: update-meter
summary: Update meter
description: Update a meter.
parameters:
- name: meterId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Meter updated response.
content:
application/json:
schema:
$ref: '#/components/schemas/Meter'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Meters
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMeterRequest'
x-unstable: true
delete:
operationId: delete-meter
summary: Delete meter
description: Delete a meter.
parameters:
- name: meterId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'204':
description: Deleted response.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Meters
/openmeter/meters/{meterId}/query:
post:
operationId: query-meter
parameters:
- name: meterId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
description: |-
Query a meter for usage.
Set `Accept: application/json` (the default) to get a structured JSON response.
Set `Accept: text/csv` to download the same data as a CSV file suitable for
spreadsheets. The CSV columns, in order, are:
`from, to, [subject,] [customer_id, customer_key, customer_name,] <dimensions...>, value`
The `subject` column is emitted only when `subject` is in the query's
`group_by_dimensions`. The three `customer_*` columns are emitted together only
when `customer_id` is in the query's `group_by_dimensions`.
summary: Query meter
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/MeterQueryResult'
text/csv:
schema:
type: string
examples:
Grouped by customer and dimensions:
summary: Grouped by customer and dimensions
value: |-
from,to,customer_id,customer_key,customer_name,model,type,value
2023-01-01T00:00:00Z,2023-01-01T00:01:00Z,01G65Z755AFWAKHE12NY0CQ9FH,acme-inc,Acme Inc.,gpt-4-turbo,input,12
2023-01-01T00:01:00Z,2023-01-01T00:02:00Z,01G65Z755AFWAKHE12NY0CQ9FH,acme-inc,Acme Inc.,gpt-4-turbo,input,20
2023-01-01T00:02:00Z,2023-01-01T00:03:00Z,01G65Z755B3YZ1KRA9W8V7PS2D,globex,Globex Corp,gpt-4-turbo,output,4
No group-by dimensions:
summary: No group-by dimensions
value: |-
from,to,value
2023-01-01T00:00:00Z,2023-01-01T00:01:00Z,12
2023-01-01T00:01:00Z,2023-01-01T00:02:00Z,20
2023-01-01T00:02:00Z,2023-01-01T00:03:00Z,4
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
x-unstable: true
tags:
- Meters
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MeterQueryRequest'
/openmeter/plans:
get:
operationId: list-plans
summary: List plans
description: List all plans.
parameters:
- $ref: '#/components/parameters/PagePaginationQuery'
- name: sort
in: query
required: false
description: |-
Sort plans returned in the response. Supported sort attributes are:
- `id`
- `key`
- `version`
- `created_at` (default)
- `updated_at`
schema:
$ref: '#/components/schemas/SortQuery'
explode: false
style: form
- name: filter
in: query
required: false
description: Filter plans returned in the response.
schema:
$ref: '#/components/schemas/ListPlansParamsFilter'
style: deepObject
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/PlanPagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Product Catalog
x-unstable: true
post:
operationId: create-plan
summary: Create plan
description: Create a new plan.
responses:
'201':
description: Plan created response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingPlan'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Product Catalog
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePlanRequest'
x-unstable: true
/openmeter/plans/{planId}:
put:
operationId: update-plan
summary: Update plan
description: Update a plan by id.
parameters:
- name: planId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Plan upsert response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingPlan'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'410':
$ref: '#/components/responses/Gone'
tags:
- OpenMeter Product Catalog
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertPlanRequest'
x-unstable: true
get:
operationId: get-plan
summary: Get plan
description: Get a plan by id.
parameters:
- name: planId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Plan response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingPlan'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'410':
$ref: '#/components/responses/Gone'
tags:
- OpenMeter Product Catalog
x-unstable: true
delete:
operationId: delete-plan
summary: Delete plan
description: Delete a plan by id.
parameters:
- name: planId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'204':
description: Deleted response.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Product Catalog
x-unstable: true
/openmeter/plans/{planId}/addons:
get:
operationId: list-plan-addons
summary: List add-ons for plan
description: List add-ons associated with a plan.
parameters:
- name: planId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
- $ref: '#/components/parameters/PagePaginationQuery'
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/PlanAddonPagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Product Catalog
x-unstable: true
post:
operationId: create-plan-addon
summary: Add add-on to plan
description: Add an add-on to a plan.
parameters:
- name: planId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'201':
description: PlanAddon created response.
content:
application/json:
schema:
$ref: '#/components/schemas/PlanAddon'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Product Catalog
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePlanAddonRequest'
x-unstable: true
/openmeter/plans/{planId}/addons/{planAddonId}:
get:
operationId: get-plan-addon
summary: Get add-on association for plan
description: Get an add-on association for a plan.
parameters:
- name: planId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
- name: planAddonId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: PlanAddon response.
content:
application/json:
schema:
$ref: '#/components/schemas/PlanAddon'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Product Catalog
x-unstable: true
put:
operationId: update-plan-addon
summary: Update add-on association for plan
description: Update an add-on association for a plan.
parameters:
- name: planId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
- name: planAddonId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: PlanAddon upsert response.
content:
application/json:
schema:
$ref: '#/components/schemas/PlanAddon'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Product Catalog
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertPlanAddonRequest'
x-unstable: true
delete:
operationId: delete-plan-addon
summary: Remove add-on from plan
description: Remove an add-on from a plan.
parameters:
- name: planId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
- name: planAddonId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'204':
description: Deleted response.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Product Catalog
x-unstable: true
/openmeter/plans/{planId}/archive:
post:
operationId: archive-plan
summary: Archive plan version
description: Archive a plan version.
parameters:
- name: planId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Plan updated response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingPlan'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Product Catalog
x-unstable: true
/openmeter/plans/{planId}/publish:
post:
operationId: publish-plan
summary: Publish plan version
description: Publish a plan version.
parameters:
- name: planId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Plan updated response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingPlan'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Product Catalog
x-unstable: true
/openmeter/profiles:
get:
operationId: list-billing-profiles
summary: List billing profiles
description: List billing profiles.
parameters:
- $ref: '#/components/parameters/PagePaginationQuery'
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingProfilePagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Billing Settings
post:
operationId: create-billing-profile
summary: Create a new billing profile
description: |-
Create a new billing profile.
Billing profiles contain the settings for billing and controls invoice
generation. An organization can have multiple billing profiles defined. A
billing profile is linked to a specific app. This association is established
during the billing profile's creation and remains immutable.
responses:
'201':
description: BillingProfile created response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingProfile'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Billing Settings
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBillingProfileRequest'
/openmeter/profiles/{id}:
get:
operationId: get-billing-profile
summary: Get a billing profile
description: Get a billing profile.
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: BillingProfile response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingProfile'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Billing Settings
put:
operationId: update-billing-profile
summary: Update a billing profile
description: Update a billing profile.
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: BillingProfile updated response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingProfile'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Billing Settings
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertBillingProfileRequest'
delete:
operationId: delete-billing-profile
summary: Delete a billing profile
description: |-
Delete a billing profile.
Only such billing profiles can be deleted that are:
- not the default profile
- not pinned to any customer using customer overrides
- only have finalized invoices
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'204':
description: Deleted response.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Billing Settings
/openmeter/subscriptions:
post:
operationId: create-subscription
summary: Create subscription
responses:
'201':
description: Subscription created response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingSubscription'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
tags:
- OpenMeter Subscriptions
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BillingSubscriptionCreate'
get:
operationId: list-subscriptions
summary: List subscriptions
parameters:
- $ref: '#/components/parameters/PagePaginationQuery'
- name: sort
in: query
required: false
description: |-
Sort subscriptions returned in the response. Supported sort attributes are:
- `id`
- `active_from` (default)
- `active_to`
The `asc` suffix is optional as the default sort order is ascending. The `desc`
suffix is used to specify a descending order.
schema:
$ref: '#/components/schemas/SortQuery'
explode: false
style: form
- name: filter
in: query
required: false
description: Filter subscriptions.
schema:
$ref: '#/components/schemas/ListSubscriptionsParamsFilter'
style: deepObject
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionPagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Subscriptions
/openmeter/subscriptions/{subscriptionId}:
get:
operationId: get-subscription
summary: Get subscription
parameters:
- name: subscriptionId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Subscription response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingSubscription'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Subscriptions
/openmeter/subscriptions/{subscriptionId}/addons:
post:
operationId: create-subscription-addon
summary: Create a new subscription add-on
description: Add add-on to a subscription.
parameters:
- name: subscriptionId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'201':
description: SubscriptionAddon created response.
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionAddon'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
tags:
- OpenMeter Subscriptions
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSubscriptionAddonRequest'
x-internal: true
x-unstable: true
get:
operationId: list-subscription-addons
summary: List subscription addons
description: List the add-ons of a subscription.
parameters:
- name: subscriptionId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
- $ref: '#/components/parameters/PagePaginationQuery'
- name: sort
in: query
required: false
description: |-
Sort subscription addons returned in the response. Supported sort attributes
are:
- `id`
- `created_at` (default)
- `updated_at`
The `asc` suffix is optional as the default sort order is ascending. The `desc`
suffix is used to specify a descending order.
schema:
$ref: '#/components/schemas/SortQuery'
explode: false
style: form
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionAddonPagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Subscriptions
x-unstable: true
/openmeter/subscriptions/{subscriptionId}/addons/{subscriptionAddonId}:
get:
operationId: get-subscription-addon
summary: Get add-on association for subscription
description: Get an add-on association for a subscription.
parameters:
- name: subscriptionId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
- name: subscriptionAddonId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: SubscriptionAddon response.
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionAddon'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Subscriptions
x-unstable: true
/openmeter/subscriptions/{subscriptionId}/cancel:
post:
operationId: cancel-subscription
summary: Cancel subscription
description: |-
Cancels the subscription. Will result in a scheduling conflict if there are
other subscriptions scheduled to start after the cancelation time.
parameters:
- name: subscriptionId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Subscription updated response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingSubscription'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
tags:
- OpenMeter Subscriptions
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BillingSubscriptionCancel'
/openmeter/subscriptions/{subscriptionId}/change:
post:
operationId: change-subscription
summary: Change subscription
description: |-
Closes a running subscription and starts a new one according to the
specification. Can be used for upgrades, downgrades, and plan changes.
parameters:
- name: subscriptionId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingSubscriptionChangeResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
tags:
- OpenMeter Subscriptions
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BillingSubscriptionChange'
/openmeter/subscriptions/{subscriptionId}/unschedule-cancelation:
post:
operationId: unschedule-cancelation
summary: Unschedule subscription cancelation
description: Unschedules the subscription cancelation.
parameters:
- name: subscriptionId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: Subscription updated response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingSubscription'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
tags:
- OpenMeter Subscriptions
/openmeter/tax-codes:
post:
operationId: create-tax-code
summary: Create tax code
responses:
'201':
description: TaxCode created response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingTaxCode'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Tax
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTaxCodeRequest'
x-unstable: true
get:
operationId: list-tax-codes
summary: List tax codes
parameters:
- $ref: '#/components/parameters/PagePaginationQuery'
- name: include_deleted
in: query
required: false
description: Include deleted tax codes in the response.
schema:
type: boolean
explode: false
style: form
responses:
'200':
description: Page paginated response.
content:
application/json:
schema:
$ref: '#/components/schemas/TaxCodePagePaginatedResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- OpenMeter Tax
x-unstable: true
/openmeter/tax-codes/{taxCodeId}:
get:
operationId: get-tax-code
summary: Get tax code
parameters:
- name: taxCodeId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: TaxCode response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingTaxCode'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Tax
x-unstable: true
put:
operationId: upsert-tax-code
summary: Upsert tax code
parameters:
- name: taxCodeId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'200':
description: TaxCode upsert response.
content:
application/json:
schema:
$ref: '#/components/schemas/BillingTaxCode'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'410':
$ref: '#/components/responses/Gone'
tags:
- OpenMeter Tax
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertTaxCodeRequest'
x-unstable: true
delete:
operationId: delete-tax-code
summary: Delete tax code
parameters:
- name: taxCodeId
in: path
required: true
schema:
$ref: '#/components/schemas/ULID'
responses:
'204':
description: Deleted response.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- OpenMeter Tax
x-unstable: true
components:
parameters:
CursorPaginationQuery:
name: page
in: query
required: false
schema:
$ref: '#/components/schemas/CursorPaginationQueryPage'
style: deepObject
PagePaginationQuery:
name: page
in: query
required: false
description: Determines which page of the collection to retrieve.
schema:
type: object
properties:
size:
type: integer
description: The number of items to include per page.
number:
type: integer
description: The page number.
additionalProperties: false
style: deepObject
schemas:
Addon:
type: object
required:
- id
- name
- created_at
- updated_at
- key
- version
- instance_type
- currency
- status
- rate_cards
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
key:
allOf:
- $ref: '#/components/schemas/ResourceKey'
description: |-
A key is a semi-unique string that is used to identify the add-on. It is used to
reference the latest `active` version of the add-on and is unique with the
version number.
title: Key
version:
type: integer
minimum: 1
description: Version of the add-on. Incremented when the add-on is updated.
title: Version
default: 1
readOnly: true
instance_type:
allOf:
- $ref: '#/components/schemas/AddonInstanceType'
description: The InstanceType of the add-ons. Can be "single" or "multiple".
title: The InstanceType of the add-ons. Can be "single" or "multiple".
currency:
allOf:
- $ref: '#/components/schemas/BillingCurrencyCode'
description: The currency code of the add-on.
title: Currency
effective_from:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
The date and time when the add-on becomes effective. When not specified, the
add-on is a draft.
title: Effective start date
readOnly: true
effective_to:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
The date and time when the add-on is no longer effective. When not specified,
the add-on is effective indefinitely.
title: Effective end date
readOnly: true
status:
allOf:
- $ref: '#/components/schemas/AddonStatus'
description: |-
The status of the add-on. Computed based on the effective start and end dates:
- `draft`: `effective_from` is not set.
- `active`: `effective_from <= now` and (`effective_to` is not set or
`now < effective_to`).
- `archived`: `effective_to <= now`.
title: Status
readOnly: true
rate_cards:
type: array
items:
$ref: '#/components/schemas/BillingRateCard'
description: The rate cards of the add-on.
title: Rate cards
validation_errors:
type: array
items:
$ref: '#/components/schemas/ProductCatalogValidationError'
description: List of validation errors.
title: Validation errors
readOnly: true
additionalProperties: false
description: |-
Add-on allows extending subscriptions with compatible plans with additional
ratecards.
AddonInstanceType:
type: string
enum:
- single
- multiple
description: |-
The instanceType of the add-on.
- `single`: Can be added to a subscription only once.
- `multiple`: Can be added to a subscription more than once.
AddonPagePaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/Addon'
meta:
$ref: '#/components/schemas/PaginatedMeta'
additionalProperties: false
description: Page paginated response.
AddonReference:
type: object
required:
- id
properties:
id:
$ref: '#/components/schemas/ULID'
additionalProperties: false
description: Addon reference.
AddonStatus:
type: string
enum:
- draft
- active
- archived
description: |-
The status of the add-on defined by the `effective_from` and `effective_to`
properties.
- `draft`: The add-on has not yet been published and can be edited.
- `active`: The add-on is published and available for use.
- `archived`: The add-on is no longer available for use.
Address:
type: object
properties:
country:
allOf:
- $ref: '#/components/schemas/CountryCode'
description: |-
Country code in [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html)
alpha-2 format.
title: Country
postal_code:
type: string
description: Postal code.
title: Postal Code
state:
type: string
description: State or province.
title: State
city:
type: string
description: City.
title: City
line1:
type: string
description: First line of the address.
title: Line 1
line2:
type: string
description: Second line of the address.
title: Line 2
phone_number:
type: string
description: Phone number.
title: Phone Number
additionalProperties: false
description: Address
AppCatalogItemPagePaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/BillingAppCatalogItem'
meta:
$ref: '#/components/schemas/PaginatedMeta'
additionalProperties: false
description: Page paginated response.
AppPagePaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/BillingApp'
meta:
$ref: '#/components/schemas/PaginatedMeta'
additionalProperties: false
description: Page paginated response.
BillingApp:
type: object
oneOf:
- $ref: '#/components/schemas/BillingAppStripe'
- $ref: '#/components/schemas/BillingAppSandbox'
- $ref: '#/components/schemas/BillingAppExternalInvoicing'
discriminator:
propertyName: type
mapping:
stripe: '#/components/schemas/BillingAppStripe'
sandbox: '#/components/schemas/BillingAppSandbox'
external_invoicing: '#/components/schemas/BillingAppExternalInvoicing'
description: Installed application.
BillingAppCapability:
type: object
required:
- type
- key
- name
- description
properties:
type:
allOf:
- $ref: '#/components/schemas/BillingAppCapabilityType'
description: Type of the capability.
key:
allOf:
- $ref: '#/components/schemas/ResourceKey'
description: Key of the capability.
name:
type: string
description: Name of the capability.
description:
type: string
description: Description of the capability.
additionalProperties: false
description: App capability describes a function that an App can perform.
example:
type: collect_payments
key: stripe_collect_payment
name: Collect Payments
description: Stripe payments collects outstanding revenue with Stripe customer's default payment method.
BillingAppCapabilityType:
type: string
enum:
- report_usage
- report_events
- calculate_tax
- invoice_customers
- collect_payments
description: |-
Supported capability types for an App.
Each capability defines an integration function that an App can perform.
BillingAppCatalogItem:
type: object
required:
- type
- name
- description
- capabilities
- install_methods
properties:
type:
allOf:
- $ref: '#/components/schemas/BillingAppType'
description: Type of the app.
readOnly: true
name:
type: string
description: Name of the app.
readOnly: true
description:
type: string
description: Description of the app.
readOnly: true
capabilities:
type: array
items:
$ref: '#/components/schemas/BillingAppCapability'
description: Capabilities of the app.
readOnly: true
install_methods:
type: array
items:
$ref: '#/components/schemas/BillingAppInstallMethods'
description: Available install methods of the app.
readOnly: true
additionalProperties: false
description: |-
Available apps for billing integrations to connect with third-party services.
Apps can have various capabilities like syncing data from or to external
systems, integrating with third-party services for tax calculation, delivery of
invoices, collection of payments, etc.
example:
type: stripe
name: Stripe
description: Stripe integration allows you to collect payments with Stripe.
capabilities:
- type: calculate_tax
key: stripe_calculate_tax
name: Calculate Tax
description: Stripe Tax calculates tax portion of the invoices.
- type: invoice_customers
key: stripe_invoice_customers
name: Invoice Customers
description: Stripe invoices customers with due amount.
- type: collect_payments
key: stripe_collect_payments
name: Collect Payments
description: Stripe payments collects outstanding revenue with Stripe customer's default payment method.
install_methods:
- with_oauth2
- with_api_key
BillingAppCustomerData:
type: object
properties:
stripe:
allOf:
- $ref: '#/components/schemas/BillingAppCustomerDataStripe'
description: Used if the customer has a linked Stripe app.
title: Stripe
external_invoicing:
allOf:
- $ref: '#/components/schemas/BillingAppCustomerDataExternalInvoicing'
description: Used if the customer has a linked external invoicing app.
title: External invoicing
additionalProperties: false
description: App customer data.
BillingAppCustomerDataExternalInvoicing:
type: object
properties:
labels:
allOf:
- $ref: '#/components/schemas/Labels'
description: Labels for this external invoicing integration on the customer.
title: Labels
additionalProperties: false
description: External invoicing customer data.
BillingAppCustomerDataStripe:
type: object
properties:
customer_id:
type: string
description: The Stripe customer ID used.
title: Stripe customer ID
example: cus_1234567890
default_payment_method_id:
type: string
description: The Stripe default payment method ID.
title: Stripe default payment method ID
example: pm_1234567890
labels:
allOf:
- $ref: '#/components/schemas/Labels'
description: Labels for this Stripe integration on the customer.
title: Labels
additionalProperties: false
description: Stripe customer data.
BillingAppExternalInvoicing:
type: object
required:
- id
- name
- created_at
- updated_at
- type
- definition
- status
- enable_draft_sync_hook
- enable_issuing_sync_hook
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
type:
type: string
enum:
- external_invoicing
description: The app type.
readOnly: true
definition:
allOf:
- $ref: '#/components/schemas/BillingAppCatalogItem'
description: The app catalog definition that this installed app is based on.
readOnly: true
status:
allOf:
- $ref: '#/components/schemas/BillingAppStatus'
description: Status of the app connection.
readOnly: true
enable_draft_sync_hook:
type: boolean
description: |-
Enable draft synchronization hook.
When enabled, invoices will pause at the draft state and wait for the
integration to call the draft synchronized endpoint before progressing to the
issuing state. This allows the external system to validate and prepare the
invoice data.
When disabled, invoices automatically progress through the draft state based on
the configured workflow timing.
enable_issuing_sync_hook:
type: boolean
description: |-
Enable issuing synchronization hook.
When enabled, invoices will pause at the issuing state and wait for the
integration to call the issuing synchronized endpoint before progressing to the
issued state. This ensures the external invoicing system has successfully
created and finalized the invoice before it is marked as issued.
When disabled, invoices automatically progress through the issuing state and are
immediately marked as issued.
additionalProperties: false
description: |-
External Invoicing app enables integration with third-party invoicing or payment
system.
The app supports a bi-directional synchronization pattern where OpenMeter
Billing manages the invoice lifecycle while the external system handles invoice
presentation and payment collection.
Integration workflow:
1. The billing system creates invoices and transitions them through lifecycle
states (draft → issuing → issued)
2. The integration receives webhook notifications about invoice state changes
3. The integration calls back to provide external system IDs and metadata
4. The integration reports payment events back via the payment status API
State synchronization is controlled by hooks that pause invoice progression
until the external system confirms synchronization via API callbacks.
BillingAppInstallMethods:
type: string
enum:
- with_oauth2
- with_api_key
- no_credentials_required
description: Supported installation methods for an app.
BillingAppReference:
type: object
required:
- id
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
description: The ID of the app.
additionalProperties: false
description: App reference.
BillingAppSandbox:
type: object
required:
- id
- name
- created_at
- updated_at
- type
- definition
- status
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
type:
type: string
enum:
- sandbox
description: The app type.
readOnly: true
definition:
allOf:
- $ref: '#/components/schemas/BillingAppCatalogItem'
description: The app catalog definition that this installed app is based on.
readOnly: true
status:
allOf:
- $ref: '#/components/schemas/BillingAppStatus'
description: Status of the app connection.
readOnly: true
additionalProperties: false
description: Sandbox app can be used for testing billing features.
BillingAppStatus:
type: string
enum:
- ready
- unauthorized
description: Connection status of an installed app.
BillingAppStripe:
type: object
required:
- id
- name
- created_at
- updated_at
- type
- definition
- status
- account_id
- livemode
- masked_api_key
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
type:
type: string
enum:
- stripe
description: The app type.
readOnly: true
definition:
allOf:
- $ref: '#/components/schemas/BillingAppCatalogItem'
description: The app catalog definition that this installed app is based on.
readOnly: true
status:
allOf:
- $ref: '#/components/schemas/BillingAppStatus'
description: Status of the app connection.
readOnly: true
account_id:
type: string
description: The Stripe account ID associated with the connected Stripe account.
readOnly: true
livemode:
type: boolean
description: Indicates whether the app is connected to a live Stripe account.
readOnly: true
masked_api_key:
type: string
description: The masked Stripe API key that only exposes the first and last few characters.
readOnly: true
additionalProperties: false
description: Stripe app.
BillingAppStripeCheckoutSessionCustomTextParams:
type: object
properties:
after_submit:
type: object
properties:
message:
type: string
maxLength: 1200
description: The custom message text (max 1200 characters).
additionalProperties: false
description: Text displayed after the payment confirmation button.
shipping_address:
type: object
properties:
message:
type: string
maxLength: 1200
description: The custom message text (max 1200 characters).
additionalProperties: false
description: Text displayed alongside shipping address collection.
submit:
type: object
properties:
message:
type: string
maxLength: 1200
description: The custom message text (max 1200 characters).
additionalProperties: false
description: Text displayed alongside the payment confirmation button.
terms_of_service_acceptance:
type: object
properties:
message:
type: string
maxLength: 1200
description: The custom message text (max 1200 characters).
additionalProperties: false
description: Text replacing the default terms of service agreement text.
additionalProperties: false
description: Custom text displayed at various stages of the checkout flow.
BillingAppStripeCheckoutSessionMode:
type: string
enum:
- setup
description: |-
Stripe Checkout Session mode.
Determines the primary purpose of the checkout session.
BillingAppStripeCheckoutSessionUIMode:
type: string
enum:
- embedded
- hosted
description: Checkout Session UI mode.
BillingAppStripeCreateCheckoutSessionBillingAddressCollection:
type: string
enum:
- auto
- required
description: Controls whether Checkout collects the customer's billing address.
BillingAppStripeCreateCheckoutSessionConsentCollection:
type: object
properties:
payment_method_reuse_agreement:
allOf:
- $ref: '#/components/schemas/BillingAppStripeCreateCheckoutSessionConsentCollectionPaymentMethodReuseAgreement'
description: Controls the visibility of payment method reuse agreement.
promotions:
allOf:
- $ref: '#/components/schemas/BillingAppStripeCreateCheckoutSessionConsentCollectionPromotions'
description: |-
Enables collection of promotional communication consent.
Only available to US merchants. When set to "auto", Checkout determines whether
to show the option based on the customer's locale.
terms_of_service:
allOf:
- $ref: '#/components/schemas/BillingAppStripeCreateCheckoutSessionConsentCollectionTermsOfService'
description: |-
Requires customers to accept terms of service before payment.
Requires a valid terms of service URL in your Stripe Dashboard settings.
additionalProperties: false
description: Checkout Session consent collection configuration.
BillingAppStripeCreateCheckoutSessionConsentCollectionPaymentMethodReuseAgreement:
type: object
properties:
position:
allOf:
- $ref: '#/components/schemas/BillingAppStripeCreateCheckoutSessionConsentCollectionPaymentMethodReuseAgreementPosition'
description: Position and visibility of the payment method reuse agreement.
additionalProperties: false
description: Payment method reuse agreement configuration.
BillingAppStripeCreateCheckoutSessionConsentCollectionPaymentMethodReuseAgreementPosition:
type: string
enum:
- auto
- hidden
description: Position of payment method reuse agreement in the UI.
BillingAppStripeCreateCheckoutSessionConsentCollectionPromotions:
type: string
enum:
- auto
- none
description: Promotional communication consent collection setting.
BillingAppStripeCreateCheckoutSessionConsentCollectionTermsOfService:
type: string
enum:
- none
- required
description: Terms of service acceptance requirement.
BillingAppStripeCreateCheckoutSessionCustomerUpdate:
type: object
properties:
address:
allOf:
- $ref: '#/components/schemas/BillingAppStripeCreateCheckoutSessionCustomerUpdateBehavior'
description: |-
Whether to save the billing address to customer.address.
Defaults to "never".
default: never
name:
allOf:
- $ref: '#/components/schemas/BillingAppStripeCreateCheckoutSessionCustomerUpdateBehavior'
description: |-
Whether to save the customer name to customer.name.
Defaults to "never".
default: never
shipping:
allOf:
- $ref: '#/components/schemas/BillingAppStripeCreateCheckoutSessionCustomerUpdateBehavior'
description: |-
Whether to save shipping information to customer.shipping.
Defaults to "never".
default: never
additionalProperties: false
description: Controls which customer fields can be updated by the checkout session.
BillingAppStripeCreateCheckoutSessionCustomerUpdateBehavior:
type: string
enum:
- auto
- never
description: Behavior for updating customer fields from checkout session.
BillingAppStripeCreateCheckoutSessionRedirectOnCompletion:
type: string
enum:
- always
- if_required
- never
description: Redirect behavior for embedded checkout sessions.
BillingAppStripeCreateCheckoutSessionRequestOptions:
type: object
properties:
billing_address_collection:
allOf:
- $ref: '#/components/schemas/BillingAppStripeCreateCheckoutSessionBillingAddressCollection'
description: |-
Whether to collect the customer's billing address.
Defaults to auto, which only collects the address when necessary for tax
calculation.
default: auto
cancel_url:
type: string
description: |-
URL to redirect customers who cancel the checkout session.
Not allowed when ui_mode is "embedded".
client_reference_id:
type: string
description: |-
Unique reference string for reconciling sessions with internal systems.
Can be a customer ID, cart ID, or any other identifier.
customer_update:
allOf:
- $ref: '#/components/schemas/BillingAppStripeCreateCheckoutSessionCustomerUpdate'
description: Controls which customer fields can be updated by the checkout session.
consent_collection:
allOf:
- $ref: '#/components/schemas/BillingAppStripeCreateCheckoutSessionConsentCollection'
description: Configuration for collecting customer consent during checkout.
currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: |-
Three-letter ISO 4217 currency code in uppercase.
Required for payment mode sessions. Optional for setup mode sessions.
custom_text:
allOf:
- $ref: '#/components/schemas/BillingAppStripeCheckoutSessionCustomTextParams'
description: Custom text to display during checkout at various stages.
expires_at:
type: integer
format: int64
description: |-
Unix timestamp when the checkout session expires.
Can be 30 minutes to 24 hours from creation. Defaults to 24 hours.
locale:
type: string
description: |-
IETF language tag for the checkout UI locale.
If blank or "auto", uses the browser's locale. Example: "en", "fr", "de".
metadata:
type: object
additionalProperties:
type: string
description: |-
Set of key-value pairs to attach to the checkout session.
Useful for storing additional structured information.
return_url:
type: string
description: |-
Return URL for embedded checkout sessions after payment authentication.
Required if ui_mode is "embedded" and redirect-based payment methods are
enabled.
success_url:
type: string
description: |-
Success URL to redirect customers after completing payment or setup.
Not allowed when ui_mode is "embedded". See:
https://docs.stripe.com/payments/checkout/custom-success-page
ui_mode:
allOf:
- $ref: '#/components/schemas/BillingAppStripeCheckoutSessionUIMode'
description: |-
The UI mode for the checkout session.
"hosted" displays a Stripe-hosted page. "embedded" integrates directly into your
app. Defaults to "hosted".
default: hosted
payment_method_types:
type: array
items:
type: string
description: |-
List of payment method types to enable (e.g., "card", "us_bank_account").
If not specified, Stripe enables all relevant payment methods.
redirect_on_completion:
allOf:
- $ref: '#/components/schemas/BillingAppStripeCreateCheckoutSessionRedirectOnCompletion'
description: |-
Redirect behavior for embedded checkout sessions.
Controls when to redirect users after completion. See:
https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form
tax_id_collection:
allOf:
- $ref: '#/components/schemas/BillingAppStripeCreateCheckoutSessionTaxIdCollection'
description: Configuration for collecting tax IDs during checkout.
additionalProperties: false
description: |-
Configuration options for creating a Stripe Checkout Session.
Based on Stripe's
[Checkout Session API parameters](https://docs.stripe.com/api/checkout/sessions/create).
BillingAppStripeCreateCheckoutSessionResult:
type: object
required:
- customer_id
- stripe_customer_id
- session_id
- setup_intent_id
- created_at
- mode
properties:
customer_id:
allOf:
- $ref: '#/components/schemas/ULID'
description: The customer ID in the billing system.
stripe_customer_id:
type: string
description: The Stripe customer ID.
session_id:
type: string
description: The Stripe checkout session ID.
setup_intent_id:
type: string
description: The setup intent ID created for collecting the payment method.
client_secret:
type: string
description: |-
Client secret for initializing Stripe.js on the client side.
Required for embedded checkout sessions. See:
https://docs.stripe.com/payments/checkout/custom-success-page
client_reference_id:
type: string
description: |-
The client reference ID provided in the request.
Useful for reconciling the session with your internal systems.
customer_email:
type: string
description: Customer's email address if provided to Stripe.
currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: Currency code for the checkout session.
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: Timestamp when the checkout session was created.
expires_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: Timestamp when the checkout session will expire.
metadata:
type: object
additionalProperties:
type: string
description: Metadata attached to the checkout session.
status:
type: string
description: |-
The status of the checkout session.
See:
https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-status
url:
type: string
description: URL to redirect customers to the checkout page (for hosted mode).
mode:
allOf:
- $ref: '#/components/schemas/BillingAppStripeCheckoutSessionMode'
description: |-
Mode of the checkout session.
Currently only "setup" mode is supported for collecting payment methods.
cancel_url:
type: string
description: The cancel URL where customers are redirected if they cancel.
success_url:
type: string
description: The success URL where customers are redirected after completion.
return_url:
type: string
description: The return URL for embedded sessions after authentication.
additionalProperties: false
description: |-
Result of creating a Stripe Checkout Session.
Contains all the information needed to redirect customers to the checkout or
initialize an embedded checkout flow.
BillingAppStripeCreateCheckoutSessionTaxIdCollection:
type: object
properties:
enabled:
type: boolean
description: |-
Enable tax ID collection during checkout.
Defaults to false.
default: false
required:
allOf:
- $ref: '#/components/schemas/BillingAppStripeCreateCheckoutSessionTaxIdCollectionRequired'
description: |-
Whether tax ID collection is required.
Defaults to "never".
default: never
additionalProperties: false
description: Tax ID collection configuration for checkout sessions.
BillingAppStripeCreateCheckoutSessionTaxIdCollectionRequired:
type: string
enum:
- if_supported
- never
description: Tax ID collection requirement level.
BillingAppStripeCreateCustomerPortalSessionOptions:
type: object
properties:
configuration_id:
type: string
description: |-
The ID of an existing
[Stripe configuration](https://docs.stripe.com/api/customer_portal/configurations)
to use for this session, describing its functionality and features. If not
specified, the session uses the default configuration.
locale:
type: string
description: |-
The IETF
[language tag](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-locale)
of the locale customer portal is displayed in. If blank or `auto`, the
customer's preferred_locales or browser's locale is used.
return_url:
type: string
description: |-
The
[URL to redirect](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url)
the customer to after they have completed their requested actions.
additionalProperties: false
description: Request to create a Stripe Customer Portal Session.
BillingAppStripeCreateCustomerPortalSessionResult:
type: object
required:
- id
- stripe_customer_id
- configuration_id
- livemode
- created_at
- return_url
- locale
- url
properties:
id:
type: string
description: |-
The ID of the customer portal session.
See:
https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-id
stripe_customer_id:
type: string
description: The ID of the stripe customer.
configuration_id:
type: string
description: |-
Configuration used to customize the customer portal.
See:
https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-configuration
livemode:
type: boolean
description: |-
Livemode.
See:
https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-livemode
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
Created at.
See:
https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-created
return_url:
type: string
description: |-
Return URL.
See:
https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-return_url
locale:
type: string
description: |-
The IETF language tag of the locale customer portal is displayed in.
See:
https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-locale
url:
type: string
description: |-
The URL to redirect the customer to after they have completed their requested
actions.
additionalProperties: false
description: |-
Result of creating a
[Stripe Customer Portal Session](https://docs.stripe.com/api/customer_portal/sessions/object).
Contains all the information needed to redirect the customer to the Stripe
Customer Portal.
BillingAppType:
type: string
enum:
- sandbox
- stripe
- external_invoicing
description: The type of the app.
BillingCharge:
type: object
oneOf:
- $ref: '#/components/schemas/BillingChargeFlatFee'
- $ref: '#/components/schemas/BillingChargeUsageBased'
discriminator:
propertyName: type
mapping:
flat_fee: '#/components/schemas/BillingChargeFlatFee'
usage_based: '#/components/schemas/BillingChargeUsageBased'
description: Customer charge.
title: Customer charge
BillingChargeFlatFee:
type: object
required:
- id
- name
- created_at
- updated_at
- type
- customer
- lifecycle_controller
- currency
- status
- invoice_at
- service_period
- full_service_period
- billing_period
- settlement_mode
- payment_term
- proration_configuration
- amount_after_proration
- price
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
type:
type: string
enum:
- flat_fee
description: The type of the charge.
title: Type
customer:
allOf:
- $ref: '#/components/schemas/BillingCustomerReference'
description: The customer owning the charge.
title: Customer
readOnly: true
lifecycle_controller:
allOf:
- $ref: '#/components/schemas/BillingLifecycleController'
description: |-
Indicates whether the charge lifecycle is controlled by OpenMeter or manually
overridden by the API user.
title: Lifecycle controller
readOnly: true
subscription:
allOf:
- $ref: '#/components/schemas/BillingSubscriptionReference'
description: |-
The subscription that originated the charge, when the charge was created from a
subscription item.
title: Subscription
readOnly: true
currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: The currency of the charge.
title: Currency
status:
allOf:
- $ref: '#/components/schemas/BillingChargeStatus'
description: The lifecycle status of the charge.
title: Status
readOnly: true
invoice_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: The timestamp when the charge is intended to be invoiced.
title: Invoice at
service_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The effective service period covered by the charge.
title: Service period
full_service_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The full, unprorated service period of the charge.
title: Full service period
readOnly: true
billing_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The billing period the charge belongs to.
title: Billing period
readOnly: true
advance_after:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
The earliest time when the charge should be advanced again by background
processing.
title: Advance after
readOnly: true
unique_reference_id:
type: string
description: Unique reference ID of the charge.
title: Unique reference ID
settlement_mode:
allOf:
- $ref: '#/components/schemas/BillingSettlementMode'
description: Settlement mode of the charge.
title: Settlement mode
tax_config:
allOf:
- $ref: '#/components/schemas/BillingTaxConfig'
description: Tax configuration of the charge.
title: Tax configuration
payment_term:
allOf:
- $ref: '#/components/schemas/BillingPricePaymentTerm'
description: Payment term of the flat fee charge.
title: Payment term
discounts:
allOf:
- $ref: '#/components/schemas/BillingChargeFlatFeeDiscounts'
description: The discounts applied to the charge.
title: Discounts
feature_key:
type: string
description: The feature associated with the charge, when applicable.
title: Feature key
proration_configuration:
allOf:
- $ref: '#/components/schemas/BillingRateCardProrationConfiguration'
description: The proration configuration of the charge.
title: Proration configuration
amount_after_proration:
allOf:
- $ref: '#/components/schemas/CurrencyAmount'
description: The amount after proration of the charge.
title: Amount after proration
readOnly: true
price:
allOf:
- $ref: '#/components/schemas/BillingPrice'
description: The price of the charge.
title: Price
readOnly: true
system_intent:
allOf:
- $ref: '#/components/schemas/BillingChargeFlatFeeSystemIntent'
description: |-
Current intent from the system lifecycle controller for a charge that has an
active manual override. The top-level charge fields remain the effective
customer-facing intent.
title: System intent
readOnly: true
additionalProperties: false
description: A flat fee charge for a customer.
title: Flat fee charge
BillingChargeFlatFeeDiscounts:
type: object
properties:
percentage:
type: number
minimum: 0
maximum: 100
description: Percentage discount applied to the price (0–100).
additionalProperties: false
description: |-
Discounts applicable to flat fee charges.
This is the same as `ProductCatalog.Discounts` but without the `usage` field,
which is not applicable to flat fee charges.
title: Flat fee charge discounts
BillingChargeFlatFeeSystemIntent:
type: object
required:
- name
- invoice_at
- service_period
- full_service_period
- billing_period
- payment_term
- proration_configuration
- amount_before_proration
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
invoice_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: The timestamp when the charge is intended to be invoiced.
title: Invoice at
service_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The effective service period covered by the charge.
title: Service period
full_service_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The full, unprorated service period of the charge.
title: Full service period
readOnly: true
billing_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The billing period the charge belongs to.
title: Billing period
readOnly: true
payment_term:
allOf:
- $ref: '#/components/schemas/BillingPricePaymentTerm'
description: Payment term of the flat fee charge.
title: Payment term
discounts:
allOf:
- $ref: '#/components/schemas/BillingChargeFlatFeeDiscounts'
description: The discounts applied to the charge.
title: Discounts
proration_configuration:
allOf:
- $ref: '#/components/schemas/BillingRateCardProrationConfiguration'
description: The proration configuration of the charge.
title: Proration configuration
amount_before_proration:
allOf:
- $ref: '#/components/schemas/CurrencyAmount'
description: The amount before proration of the system lifecycle controller flat fee intent.
title: Amount before proration
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
The timestamp when the system lifecycle controller intent was deleted. The
effective charge can remain visible while a manual override is active.
title: Deleted at
readOnly: true
additionalProperties: false
description: |-
Flat fee intent fields from the system lifecycle controller shadowed by a manual
override.
title: Flat fee system lifecycle controller charge intent
BillingChargeReference:
type: object
required:
- id
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
description: Unique identifier for the charge.
title: ID
readOnly: true
additionalProperties: false
description: Reference to a charge associated with an invoice line.
BillingChargeStatus:
type: string
enum:
- created
- active
- final
- deleted
description: |-
Lifecycle status of a charge.
Values:
- `created`: The charge has been created but is not active yet.
- `active`: The charge is active.
- `final`: The charge is fully finalized and no further changes are expected.
- `deleted`: The charge has been deleted.
title: Charge status
BillingChargeTotals:
type: object
required:
- booked
properties:
booked:
allOf:
- $ref: '#/components/schemas/BillingTotals'
description: The amount of the charge already booked to the internal accounting system.
title: Booked
readOnly: true
realtime:
allOf:
- $ref: '#/components/schemas/BillingTotals'
description: |-
The realtime amount of the charge.
Requires the `realtime_usage` expand.
title: Realtime totals
readOnly: true
additionalProperties: false
description: |-
The totals of a change.
RealTime is only expanded when the `real_time_usage` expand is used.
BillingChargeUsageBased:
type: object
required:
- id
- name
- created_at
- updated_at
- type
- customer
- lifecycle_controller
- currency
- status
- invoice_at
- service_period
- full_service_period
- billing_period
- settlement_mode
- feature_key
- totals
- price
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
type:
type: string
enum:
- usage_based
description: The type of the charge.
title: Type
customer:
allOf:
- $ref: '#/components/schemas/BillingCustomerReference'
description: The customer owning the charge.
title: Customer
readOnly: true
lifecycle_controller:
allOf:
- $ref: '#/components/schemas/BillingLifecycleController'
description: |-
Indicates whether the charge lifecycle is controlled by OpenMeter or manually
overridden by the API user.
title: Lifecycle controller
readOnly: true
subscription:
allOf:
- $ref: '#/components/schemas/BillingSubscriptionReference'
description: |-
The subscription that originated the charge, when the charge was created from a
subscription item.
title: Subscription
readOnly: true
currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: The currency of the charge.
title: Currency
status:
allOf:
- $ref: '#/components/schemas/BillingChargeStatus'
description: The lifecycle status of the charge.
title: Status
readOnly: true
invoice_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: The timestamp when the charge is intended to be invoiced.
title: Invoice at
service_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The effective service period covered by the charge.
title: Service period
full_service_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The full, unprorated service period of the charge.
title: Full service period
readOnly: true
billing_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The billing period the charge belongs to.
title: Billing period
readOnly: true
advance_after:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
The earliest time when the charge should be advanced again by background
processing.
title: Advance after
readOnly: true
unique_reference_id:
type: string
description: Unique reference ID of the charge.
title: Unique reference ID
settlement_mode:
allOf:
- $ref: '#/components/schemas/BillingSettlementMode'
description: Settlement mode of the charge.
title: Settlement mode
tax_config:
allOf:
- $ref: '#/components/schemas/BillingTaxConfig'
description: Tax configuration of the charge.
title: Tax configuration
discounts:
allOf:
- $ref: '#/components/schemas/BillingRateCardDiscounts'
description: Discounts applied to the usage-based charge.
title: Discounts
feature_key:
type: string
description: The feature associated with the charge.
title: Feature key
totals:
allOf:
- $ref: '#/components/schemas/BillingChargeTotals'
description: Aggregated booked and realtime totals for the charge.
title: Totals for the charge
readOnly: true
price:
allOf:
- $ref: '#/components/schemas/BillingPrice'
description: The price of the charge.
title: Price
system_intent:
allOf:
- $ref: '#/components/schemas/BillingChargeUsageBasedSystemIntent'
description: |-
Current intent from the system lifecycle controller for a charge that has an
active manual override. The top-level charge fields remain the effective
customer-facing intent.
title: System intent
readOnly: true
additionalProperties: false
description: A usage-based charge for a customer.
title: Usage-based charge
BillingChargeUsageBasedSystemIntent:
type: object
required:
- name
- invoice_at
- service_period
- full_service_period
- billing_period
- price
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
invoice_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: The timestamp when the charge is intended to be invoiced.
title: Invoice at
service_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The effective service period covered by the charge.
title: Service period
full_service_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The full, unprorated service period of the charge.
title: Full service period
readOnly: true
billing_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The billing period the charge belongs to.
title: Billing period
readOnly: true
discounts:
allOf:
- $ref: '#/components/schemas/BillingRateCardDiscounts'
description: Discounts applied to the usage-based charge.
title: Discounts
price:
allOf:
- $ref: '#/components/schemas/BillingPrice'
description: The price of the charge.
title: Price
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
The timestamp when the system lifecycle controller intent was deleted. The
effective charge can remain visible while a manual override is active.
title: Deleted at
readOnly: true
additionalProperties: false
description: |-
Usage-based intent fields from the system lifecycle controller shadowed by a
manual override.
title: Usage-based system lifecycle controller charge intent
BillingChargesExpand:
type: string
enum:
- real_time_usage
description: |-
Expands for customer charges.
Values:
- `real_time_usage`: The charge's real-time usage.
title: Customer charge expands
BillingCostBasis:
type: object
required:
- id
- fiat_code
- rate
- created_at
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
fiat_code:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: The fiat currency code for the cost basis.
rate:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The cost rate for the currency.
effective_from:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
An ISO-8601 timestamp representation of the date from which the cost basis is
effective. If not provided, it will be effective immediately and will be set to
`now` by the system.
effective_to:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
An ISO-8601 timestamp representation of the date until which the cost basis is
effective. If provided, it must be later than `effective_from`. If not provided,
it remains effective until superseded.
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
additionalProperties: false
description: Describes currency basis supported by billing system.
BillingCreditAdjustment:
type: object
required:
- name
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
additionalProperties: false
description: |-
A credit adjustment can be used to make manual adjustments to a customer's
credit balance.
Supported use-cases:
- Usage correction
title: Credit adjustment
BillingCreditAvailabilityPolicy:
type: string
enum:
- on_creation
description: |-
When credits become available for consumption.
- `on_creation`: Credits are available as soon as the grant is created.
- `on_authorization`: Credits are available once the payment is authorized.
- `on_settlement`: Credits are available once the payment is settled.
title: Credit availability policy
BillingCreditBalances:
type: object
required:
- retrieved_at
- balances
properties:
retrieved_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: The timestamp of the balance retrieval.
readOnly: true
balances:
type: array
items:
$ref: '#/components/schemas/CreditBalance'
description: The balances by currencies.
readOnly: true
additionalProperties: false
description: The balances of the credits of a customer.
title: Credit balances
BillingCreditFundingMethod:
type: string
enum:
- none
- invoice
- external
description: |-
The funding method describes how the grant is funded.
- `none`: No funding workflow applies, for example promotional grants
- `invoice`: The grant is funded by an in-system invoice flow
- `external`: The grant is funded outside the system (e.g., wire transfer,
external invoice, or manual reconciliation)
title: Credit funding method
BillingCreditGrant:
type: object
required:
- id
- name
- created_at
- updated_at
- funding_method
- currency
- amount
- status
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
funding_method:
allOf:
- $ref: '#/components/schemas/BillingCreditFundingMethod'
description: Funding method of the grant.
currency:
allOf:
- $ref: '#/components/schemas/BillingCurrencyCode'
description: The currency of the granted credits.
amount:
allOf:
- $ref: '#/components/schemas/Numeric'
description: Granted credit amount.
purchase:
allOf:
- $ref: '#/components/schemas/BillingCreditGrantPurchase'
description: Present when a funding workflow applies (funding_method is not `none`).
tax_config:
allOf:
- $ref: '#/components/schemas/BillingCreditGrantTaxConfig'
description: |-
Tax configuration for the grant.
For `invoice` and `external` funding methods, tax configuration should be
provided to ensure correct revenue recognition. When not provided, the default
credit grant tax code is applied, if that's not set the global default taxcode
is used.
invoice:
allOf:
- $ref: '#/components/schemas/BillingCreditGrantInvoiceReference'
description: Available when `funding_method` is `invoice`.
readOnly: true
filters:
$ref: '#/components/schemas/BillingCreditGrantFilters'
priority:
type: integer
format: int16
minimum: 1
maximum: 1000
description: Draw-down priority of the grant. Lower values have higher priority.
default: 10
effective_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
The timestamp when the credit grant becomes effective.
Defaults to the current date and time.
key:
allOf:
- $ref: '#/components/schemas/ExternalResourceKey'
description: |-
Idempotency key for the credit grant creation request.
When provided, reusing the same key returns an HTTP 409 Conflict instead of
creating a duplicate grant, which makes create requests safe to retry.
expires_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
The timestamp when the credit grant expires.
Calculated from the grant effective time and `expires_after` if provided.
readOnly: true
voided_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: Timestamp when the grant was voided.
readOnly: true
status:
allOf:
- $ref: '#/components/schemas/BillingCreditGrantStatus'
description: Current lifecycle status of the grant.
readOnly: true
additionalProperties: false
description: |-
A credit grant allocates credits to a customer.
Credits are drawn down against charges according to the settlement mode
configured on the rate card.
title: Credit grant
BillingCreditGrantFilters:
type: object
properties:
features:
type: array
items:
$ref: '#/components/schemas/ResourceKey'
description: |-
Limit the credit grant to specific features. If no features are specified, the
credit grant can be used for any feature.
example:
- input_tokens
- output_tokens
additionalProperties: false
description: Filters for the credit grant.
BillingCreditGrantInvoiceReference:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
description: Identifier of the invoice associated with the grant.
readOnly: true
line:
type: object
properties:
id:
$ref: '#/components/schemas/ULID'
required:
- id
additionalProperties: false
description: Identifier of the invoice line associated with the grant.
readOnly: true
additionalProperties: false
description: Invoice references for the grant.
BillingCreditGrantPurchase:
type: object
required:
- currency
- amount
properties:
currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: Currency of the purchase amount.
per_unit_cost_basis:
allOf:
- $ref: '#/components/schemas/Numeric'
description: |-
Cost basis per credit unit used to calculate the purchase amount.
If `per_unit_cost_basis` is 0.50 and credit amount is $100.00, the total charge
is $50.00. The value must be greater than 0. If the cost basis is 0, use
`funding_method=none` instead.
Defaults to 1.0.
default: '1.0'
amount:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The purchase amount. Calculated from `per_unit_cost_basis` and credit `amount`.
readOnly: true
availability_policy:
allOf:
- $ref: '#/components/schemas/BillingCreditAvailabilityPolicy'
description: |-
Controls when credits become available for consumption.
Defaults to `on_creation`.
default: on_creation
settlement_status:
allOf:
- $ref: '#/components/schemas/BillingCreditPurchasePaymentSettlementStatus'
description: Current payment settlement status.
readOnly: true
additionalProperties: false
description: Purchase and payment terms of the grant.
BillingCreditGrantStatus:
type: string
enum:
- pending
- active
- expired
- voided
description: |-
Credit grant lifecycle status.
- `pending`: The credit block has been created but is not yet valid.
(`effective_at` is in the future or availability_policy is not met)
- `active`: The credit block is currently valid and eligible for consumption.
(`effective_at` is in the past, `expires_at` is in the future and
availability_policy is met)
- `expired`: The credit block expired with remaining unused balance,
`expires_at` time has passed.
- `voided`: The credit block was voided. Remaining balance is forfeited.
title: Credit grant lifecycle status
BillingCreditGrantTaxConfig:
type: object
properties:
behavior:
allOf:
- $ref: '#/components/schemas/BillingTaxBehavior'
description: Tax behavior applied to the invoice line item.
tax_code:
allOf:
- $ref: '#/components/schemas/TaxCodeReference'
description: Tax code applied to the invoice line item.
additionalProperties: false
description: |-
Tax configuration for a credit grant.
Tax configuration should be provided to ensure correct revenue recognition,
including for externally funded grants.
title: Tax configuration for a credit grant
BillingCreditGrantVoidPaymentAdjustment:
type: string
enum:
- none
description: |-
Describes how voiding a credit grant adjusts related payment state.
- `none`: Voiding does not adjust invoices, payment authorization, settlement,
payment intents, or external collection state.
title: Credit grant void payment adjustment
BillingCreditPurchasePaymentSettlementStatus:
type: string
enum:
- pending
- authorized
- settled
description: |-
Credit purchase payment settlement status.
- `pending`: Payment has been initiated and is not yet authorized.
- `authorized`: Payment has been authorized.
- `settled`: Payment has been settled.
title: Credit purchase payment settlement status
BillingCreditTransaction:
type: object
required:
- id
- name
- created_at
- booked_at
- type
- currency
- amount
- available_balance
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
booked_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: The date and time the transaction was booked.
readOnly: true
type:
allOf:
- $ref: '#/components/schemas/BillingCreditTransactionType'
description: The type of credit transaction.
readOnly: true
currency:
allOf:
- $ref: '#/components/schemas/BillingCurrencyCode'
description: Currency of the balance affected by the transaction.
readOnly: true
amount:
allOf:
- $ref: '#/components/schemas/Numeric'
description: |-
Signed amount of the credit movement. Positive values add balance, negative
values reduce balance.
readOnly: true
available_balance:
type: object
properties:
before:
$ref: '#/components/schemas/Numeric'
after:
$ref: '#/components/schemas/Numeric'
required:
- before
- after
additionalProperties: false
description: The available balance before and after the transaction.
readOnly: true
additionalProperties: false
description: |-
A credit transaction represents a single credit movement on the customer's
balance.
Credit transactions are immutable.
title: Credit transaction
BillingCreditTransactionType:
type: string
enum:
- funded
- consumed
- expired
- voided
description: |-
The type of the credit transaction.
- `funded`: Credit granted and available for consumption.
- `consumed`: Credit consumed by usage or fees.
- `expired`: Credit removed because it expired before being used.
- `voided`: Credit removed because the grant was voided before being used.
BillingCurrency:
type: object
oneOf:
- $ref: '#/components/schemas/BillingCurrencyFiat'
- $ref: '#/components/schemas/BillingCurrencyCustom'
discriminator:
propertyName: type
mapping:
fiat: '#/components/schemas/BillingCurrencyFiat'
custom: '#/components/schemas/BillingCurrencyCustom'
description: Fiat or custom currency.
BillingCurrencyCode:
type: string
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: Fiat or custom currency code.
x-go-type: string
BillingCurrencyCodeCustom:
type: string
minLength: 3
maxLength: 24
description: |-
Custom currency code. It should be a unique code but not conflicting with any
existing fiat currency codes.
BillingCurrencyCustom:
type: object
required:
- type
- name
- id
- code
- created_at
properties:
type:
type: string
enum:
- custom
description: The type of the currency.
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
The name of the currency. It should be a human-readable string that represents
the name of the currency, such as "US Dollar" or "Euro".
symbol:
type: string
minLength: 1
description: |-
The symbol of the currency. It should be a string that represents the symbol of
the currency, such as "$" for US Dollar or "€" for Euro.
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
code:
$ref: '#/components/schemas/BillingCurrencyCodeCustom'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of the custom currency creation date.
readOnly: true
additionalProperties: false
description: Describes custom currency.
BillingCurrencyFiat:
type: object
required:
- type
- name
- code
properties:
type:
type: string
enum:
- fiat
description: The type of the currency.
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
The name of the currency. It should be a human-readable string that represents
the name of the currency, such as "US Dollar" or "Euro".
symbol:
type: string
minLength: 1
description: |-
The symbol of the currency. It should be a string that represents the symbol of
the currency, such as "$" for US Dollar or "€" for Euro.
code:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
readOnly: true
additionalProperties: false
description: Currency describes a currency supported by the billing system.
BillingCurrencyType:
type: string
enum:
- fiat
- custom
description: |-
Currency type for custom currencies. It should be a unique code but not
conflicting with any existing standard currency codes.
BillingCustomer:
type: object
required:
- id
- name
- created_at
- updated_at
- key
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
key:
$ref: '#/components/schemas/ExternalResourceKey'
usage_attribution:
allOf:
- $ref: '#/components/schemas/BillingCustomerUsageAttribution'
description: Mapping to attribute metered usage to the customer by the event subject.
title: Usage Attribution
primary_email:
type: string
description: The primary email address of the customer.
title: Primary Email
currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: Currency of the customer. Used for billing, tax and invoicing.
title: Currency
billing_address:
allOf:
- $ref: '#/components/schemas/Address'
description: The billing address of the customer. Used for tax and invoicing.
title: Billing Address
additionalProperties: false
description: |-
Customers can be individuals or organizations that can subscribe to plans and
have access to features.
BillingCustomerData:
type: object
properties:
billing_profile:
allOf:
- $ref: '#/components/schemas/BillingProfileReference'
description: |-
The billing profile for the customer.
If not provided, the default billing profile will be used.
title: Billing profile
app_data:
allOf:
- $ref: '#/components/schemas/BillingAppCustomerData'
description: App customer data.
title: App customer data
additionalProperties: false
description: Billing customer data.
BillingCustomerReference:
type: object
required:
- id
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
description: The ID of the customer.
additionalProperties: false
description: Customer reference.
BillingCustomerStripeCreateCheckoutSessionRequest:
type: object
required:
- stripe_options
properties:
stripe_options:
allOf:
- $ref: '#/components/schemas/BillingAppStripeCreateCheckoutSessionRequestOptions'
description: |-
Options for configuring the Stripe Checkout Session.
These options are passed directly to Stripe's
[checkout session creation API](https://docs.stripe.com/api/checkout/sessions/create).
additionalProperties: false
description: |-
Request to create a Stripe Checkout Session for the customer.
Checkout Sessions are used to collect payment method information from customers
in a secure, Stripe-hosted interface. This integration uses setup mode to
collect payment methods that can be charged later for subscription billing.
BillingCustomerStripeCreateCustomerPortalSessionRequest:
type: object
required:
- stripe_options
properties:
stripe_options:
allOf:
- $ref: '#/components/schemas/BillingAppStripeCreateCustomerPortalSessionOptions'
description: Options for configuring the Stripe Customer Portal Session.
additionalProperties: false
description: |-
Request to create a Stripe Customer Portal Session for the customer.
Useful to redirect the customer to the Stripe Customer Portal to manage their
payment methods, change their billing address and access their invoice history.
Only returns URL if the customer billing profile is linked to a stripe app and
customer.
BillingCustomerUsageAttribution:
type: object
required:
- subject_keys
properties:
subject_keys:
type: array
items:
$ref: '#/components/schemas/UsageAttributionSubjectKey'
minItems: 0
description: |-
The subjects that are attributed to the customer. Can be empty when no usage
event subjects are associated with the customer.
title: Subject Keys
additionalProperties: false
description: |-
Mapping to attribute metered usage to the customer. One customer can have zero
or more subjects, but one subject can only belong to one customer.
BillingEntitlementAccessResult:
type: object
required:
- type
- feature_key
- has_access
properties:
type:
allOf:
- $ref: '#/components/schemas/BillingEntitlementType'
description: The type of the entitlement.
example: static
readOnly: true
feature_key:
allOf:
- $ref: '#/components/schemas/ResourceKey'
description: The feature key of the entitlement.
example: available_models
readOnly: true
has_access:
type: boolean
description: |-
Whether the customer has access to the feature. Always true for `boolean` and
`static` entitlements. Depends on balance for `metered` entitlements.
example: true
readOnly: true
config:
type: string
description: |-
Only available for static entitlements. Config is the JSON parsable
configuration of the entitlement. Useful to describe per customer configuration.
example: '{ "availableModels": ["gpt-5", "gpt-4o"] }'
readOnly: true
additionalProperties: false
description: Entitlement access result.
BillingEntitlementType:
type: string
enum:
- metered
- static
- boolean
description: The type of the entitlement.
BillingFeatureLLMTokenType:
type: string
enum:
- input
- output
- cache_read
- cache_write
- reasoning
- request
- response
description: Token type for LLM cost lookup.
BillingFeatureLLMUnitCost:
type: object
required:
- type
properties:
type:
type: string
enum:
- llm
description: The type discriminator for LLM unit cost.
provider_property:
type: string
description: |-
Meter group-by property that holds the LLM provider. Use this when the meter has
a group-by dimension for provider. Mutually exclusive with `provider`.
title: Provider property
provider:
type: string
description: |-
Static LLM provider value (e.g., "openai", "anthropic"). Use this when the
feature tracks a single provider. Mutually exclusive with `provider_property`.
title: Provider
model_property:
type: string
description: |-
Meter group-by property that holds the model ID. Use this when the meter has a
group-by dimension for model. Mutually exclusive with `model`.
title: Model property
model:
type: string
description: |-
Static model ID value (e.g., "gpt-4", "claude-3-5-sonnet"). Use this when the
feature tracks a single model. Mutually exclusive with `model_property`.
title: Model
token_type_property:
type: string
description: |-
Meter group-by property that holds the token type. Use this when the meter has a
group-by dimension for token type. Mutually exclusive with `token_type`.
title: Token type property
token_type:
allOf:
- $ref: '#/components/schemas/BillingFeatureLLMTokenType'
description: |-
Static token type value. Use this when the feature tracks a single token type
(e.g., only input tokens). `request` is an alias for `input`, `response` is an
alias for `output`. Mutually exclusive with `token_type_property`.
title: Token type
pricing:
allOf:
- $ref: '#/components/schemas/BillingFeatureLLMUnitCostPricing'
description: |-
Resolved per-token pricing from the LLM cost database. Populated in responses
when the provider and model can be determined, either from static values or from
meter group-by filters with exact matches.
title: Resolved pricing
readOnly: true
additionalProperties: false
description: |-
LLM cost lookup configuration. Each dimension (provider, model, token type) can
be specified as either a static value or a meter group-by property name
(mutually exclusive).
BillingFeatureLLMUnitCostPricing:
type: object
required:
- input_per_token
- output_per_token
properties:
input_per_token:
allOf:
- $ref: '#/components/schemas/Numeric'
description: Cost per input token in USD.
title: Input per token
output_per_token:
allOf:
- $ref: '#/components/schemas/Numeric'
description: Cost per output token in USD.
title: Output per token
cache_read_per_token:
allOf:
- $ref: '#/components/schemas/Numeric'
description: Cost per cache read token in USD.
title: Cache read per token
reasoning_per_token:
allOf:
- $ref: '#/components/schemas/Numeric'
description: Cost per reasoning token in USD.
title: Reasoning per token
cache_write_per_token:
allOf:
- $ref: '#/components/schemas/Numeric'
description: Cost per cache write token in USD.
title: Cache write per token
additionalProperties: false
description: Resolved per-token pricing from the LLM cost database.
BillingFeatureManualUnitCost:
type: object
required:
- type
- amount
properties:
type:
type: string
enum:
- manual
description: The type discriminator for manual unit cost.
amount:
allOf:
- $ref: '#/components/schemas/Numeric'
description: Fixed per-unit cost amount in USD.
additionalProperties: false
description: A fixed per-unit cost amount.
BillingFeatureUnitCost:
type: object
oneOf:
- $ref: '#/components/schemas/BillingFeatureManualUnitCost'
- $ref: '#/components/schemas/BillingFeatureLLMUnitCost'
discriminator:
propertyName: type
mapping:
manual: '#/components/schemas/BillingFeatureManualUnitCost'
llm: '#/components/schemas/BillingFeatureLLMUnitCost'
description: |-
Per-unit cost configuration for a feature. Either a fixed manual amount or a
dynamic LLM cost lookup.
BillingInstallAppExternalInvoicing:
type: object
required:
- type
- name
- create_billing_profile
properties:
type:
type: string
enum:
- external_invoicing
description: Type of the app.
name:
type: string
description: Name of the app.
create_billing_profile:
type: boolean
description: |-
If true, a billing profile will be created for the app. The Stripe app will be
also set as the default billing profile if the current default is a Sandbox app.
additionalProperties: false
description: Base model for installing an app from the catalog.
BillingInstallAppRequest:
type: object
oneOf:
- $ref: '#/components/schemas/BillingInstallAppStripeWithApiKey'
- $ref: '#/components/schemas/BillingInstallAppSandbox'
- $ref: '#/components/schemas/BillingInstallAppExternalInvoicing'
discriminator:
propertyName: type
mapping:
stripe: '#/components/schemas/BillingInstallAppStripeWithApiKey'
sandbox: '#/components/schemas/BillingInstallAppSandbox'
external_invoicing: '#/components/schemas/BillingInstallAppExternalInvoicing'
description: Request to install an app from the catalog.
BillingInstallAppResponse:
type: object
required:
- app
- default_for_capability_types
properties:
app:
allOf:
- $ref: '#/components/schemas/BillingApp'
readOnly: true
default_for_capability_types:
type: array
items:
$ref: '#/components/schemas/BillingAppCapabilityType'
readOnly: true
additionalProperties: false
description: Response of the app install.
BillingInstallAppSandbox:
type: object
required:
- type
- name
- create_billing_profile
properties:
type:
type: string
enum:
- sandbox
description: Type of the app.
name:
type: string
description: Name of the app.
create_billing_profile:
type: boolean
description: |-
If true, a billing profile will be created for the app. The Stripe app will be
also set as the default billing profile if the current default is a Sandbox app.
additionalProperties: false
description: Base model for installing an app from the catalog.
BillingInstallAppStripeWithApiKey:
type: object
required:
- type
- name
- create_billing_profile
- api_key
properties:
type:
type: string
enum:
- stripe
description: Type of the app.
name:
type: string
description: Name of the app.
create_billing_profile:
type: boolean
description: |-
If true, a billing profile will be created for the app. The Stripe app will be
also set as the default billing profile if the current default is a Sandbox app.
api_key:
type: string
description: API key for the app.
additionalProperties: false
description: Model for installing an app from the catalog with an API key.
BillingInvoice:
type: object
oneOf:
- $ref: '#/components/schemas/BillingInvoiceStandard'
discriminator:
propertyName: type
mapping:
standard: '#/components/schemas/BillingInvoiceStandard'
description: |-
An invoice issued to a customer.
The `type` field determines the concrete variant:
- `standard`: a standard invoice for charges owed.
BillingInvoiceAvailableActionDetails:
type: object
required:
- resulting_state
properties:
resulting_state:
type: string
description: The extended status the invoice will transition to after performing this action.
title: Resulting state
readOnly: true
additionalProperties: false
description: Details about an available invoice action including the resulting state.
BillingInvoiceAvailableActions:
type: object
properties:
advance:
allOf:
- $ref: '#/components/schemas/BillingInvoiceAvailableActionDetails'
description: Advance the invoice to the next workflow step.
title: Advance
readOnly: true
approve:
allOf:
- $ref: '#/components/schemas/BillingInvoiceAvailableActionDetails'
description: Approve the invoice for issuance.
title: Approve
readOnly: true
delete:
allOf:
- $ref: '#/components/schemas/BillingInvoiceAvailableActionDetails'
description: Delete the invoice.
title: Delete
readOnly: true
retry:
allOf:
- $ref: '#/components/schemas/BillingInvoiceAvailableActionDetails'
description: Retry a failed workflow step.
title: Retry
readOnly: true
snapshot_quantities:
allOf:
- $ref: '#/components/schemas/BillingInvoiceAvailableActionDetails'
description: Snapshot the current usage quantities.
title: Snapshot quantities
readOnly: true
additionalProperties: false
description: |-
The set of state-transition actions available for an invoice in its current
status.
A field is present only when that action is permitted from the current state.
BillingInvoiceCustomer:
type: object
required:
- name
- id
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
usage_attribution:
allOf:
- $ref: '#/components/schemas/BillingCustomerUsageAttribution'
description: Mapping to attribute metered usage to the customer by the event subject.
title: Usage Attribution
billing_address:
allOf:
- $ref: '#/components/schemas/Address'
description: The billing address of the customer. Used for tax and invoicing.
title: Billing Address
id:
$ref: '#/components/schemas/ULID'
key:
allOf:
- $ref: '#/components/schemas/ExternalResourceKey'
description: |-
Optional external resource key for the customer.
Omitted when the customer was created without a key. Unlike on the customer
resource itself, the key is optional here because the invoice snapshot may
predate or omit it.
additionalProperties: false
description: Snapshot of the customer's information at the time the invoice was issued.
BillingInvoiceDetailedLine:
type: object
required:
- id
- name
- created_at
- updated_at
- service_period
- totals
- category
- quantity
- unit_price
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
service_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The service period covered by this detailed line.
title: Service period
readOnly: true
totals:
allOf:
- $ref: '#/components/schemas/BillingTotals'
description: Aggregated financial totals for the detailed line.
title: Totals
readOnly: true
category:
allOf:
- $ref: '#/components/schemas/BillingInvoiceDetailedLineCostCategory'
description: The cost category of this detailed line.
title: Category
default: regular
readOnly: true
discounts:
allOf:
- $ref: '#/components/schemas/BillingInvoiceLineDiscounts'
description: Discounts applied to this detailed line.
title: Discounts
readOnly: true
credits_applied:
type: array
items:
$ref: '#/components/schemas/BillingInvoiceLineCreditsApplied'
description: Credit applied to this detailed line.
title: Credit applied
readOnly: true
external_references:
allOf:
- $ref: '#/components/schemas/BillingInvoiceLineExternalReferences'
description: External identifiers for this detailed line.
title: External references
readOnly: true
quantity:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The quantity of the detailed line.
title: Quantity
readOnly: true
unit_price:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The unit price of the detailed line.
title: Unit Price
readOnly: true
additionalProperties: false
description: |-
A detailed (child) sub-line belonging to a parent invoice line.
Detailed lines represent the individual flat-fee components that make up a
usage-based parent line after quantity snapshotting.
BillingInvoiceDetailedLineCostCategory:
type: string
enum:
- regular
- commitment
description: Cost category of a detailed invoice line item.
BillingInvoiceDiscountReason:
type: string
enum:
- maximum_spend
- ratecard_percentage
- ratecard_usage
description: The reason a discount was applied to an invoice line.
BillingInvoiceExternalReferences:
type: object
properties:
invoicing_id:
type: string
description: The ID assigned by the external invoicing app (e.g. Stripe invoice ID).
title: Invoicing ID
readOnly: true
payment_id:
type: string
description: The ID assigned by the external payment app (e.g. Stripe payment intent ID).
title: Payment ID
readOnly: true
additionalProperties: false
description: External identifiers assigned to an invoice by third-party systems.
BillingInvoiceLine:
type: object
oneOf:
- $ref: '#/components/schemas/BillingInvoiceStandardLine'
discriminator:
propertyName: type
mapping:
standard_line: '#/components/schemas/BillingInvoiceStandardLine'
description: |-
A top-level line item on an invoice.
Each line represents a single charge, typically associated with a rate card from
a subscription. Detailed (child) lines are nested under `detailed_lines` when
present.
BillingInvoiceLineAmountDiscount:
type: object
required:
- id
- reason
- amount
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
description: Unique identifier for the discount.
title: ID
readOnly: true
reason:
allOf:
- $ref: '#/components/schemas/BillingInvoiceDiscountReason'
description: The reason this discount was applied.
title: Reason
readOnly: true
description:
type: string
description: Optional human-readable description of the discount.
title: Description
readOnly: true
external_references:
allOf:
- $ref: '#/components/schemas/BillingInvoiceLineExternalReferences'
description: External identifiers for this discount.
title: External references
readOnly: true
amount:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The monetary amount deducted.
title: Amount
readOnly: true
additionalProperties: false
description: A monetary amount discount applied to an invoice line item.
BillingInvoiceLineCreditsApplied:
type: object
required:
- amount
properties:
amount:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The monetary amount credited.
title: Amount
readOnly: true
description:
type: string
description: Optional human-readable description of the credit allocation.
title: Description
readOnly: true
additionalProperties: false
description: A credit allocation applied to an invoice line item.
BillingInvoiceLineDiscounts:
type: object
properties:
amount:
type: array
items:
$ref: '#/components/schemas/BillingInvoiceLineAmountDiscount'
description: Monetary amount discounts (e.g. from maximum spend commitments).
title: Amount discounts
readOnly: true
usage:
type: array
items:
$ref: '#/components/schemas/BillingInvoiceLineUsageDiscount'
description: Usage quantity discounts (e.g. free tier usage allowances).
title: Usage discounts
readOnly: true
additionalProperties: false
description: Discounts applied to an invoice line item.
BillingInvoiceLineExternalReferences:
type: object
properties:
invoicing_id:
type: string
description: The ID assigned by the external invoicing app.
title: Invoicing ID
readOnly: true
additionalProperties: false
description: External identifiers for an invoice line item assigned by third-party systems.
BillingInvoiceLineRateCard:
type: object
required:
- price
properties:
price:
allOf:
- $ref: '#/components/schemas/BillingPrice'
description: The price definition used to calculate charges for this line.
title: Price
tax_config:
allOf:
- $ref: '#/components/schemas/BillingRateCardTaxConfig'
description: Tax configuration snapshot for this line.
title: Tax config
feature_key:
allOf:
- $ref: '#/components/schemas/ResourceKey'
description: The feature key associated with this line's rate card.
title: Feature key
discounts:
allOf:
- $ref: '#/components/schemas/BillingRateCardDiscounts'
description: Discount configuration from the rate card.
title: Discounts
additionalProperties: false
description: Rate card configuration snapshot for a usage-based invoice line.
BillingInvoiceLineUsageDiscount:
type: object
required:
- id
- reason
- quantity
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
description: Unique identifier for the discount.
title: ID
readOnly: true
reason:
allOf:
- $ref: '#/components/schemas/BillingInvoiceDiscountReason'
description: The reason this discount was applied.
title: Reason
readOnly: true
description:
type: string
description: Optional human-readable description of the discount.
title: Description
readOnly: true
external_references:
allOf:
- $ref: '#/components/schemas/BillingInvoiceLineExternalReferences'
description: External identifiers for this discount.
title: External references
readOnly: true
quantity:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The usage quantity deducted (in billing units).
title: Quantity
readOnly: true
additionalProperties: false
description: A usage quantity discount applied to an invoice line item.
BillingInvoiceNumber:
type: string
minLength: 1
maxLength: 256
description: |-
InvoiceNumber is a unique identifier for the invoice, generated by the invoicing
app.
The uniqueness depends on a lot of factors:
- app setting (unique per app or unique per customer)
- multiple app scenarios (multiple apps generating invoices with the same
prefix)
example: INV-2024-01-01-01
BillingInvoiceStandard:
type: object
required:
- id
- created_at
- updated_at
- number
- currency
- supplier
- customer
- totals
- service_period
- type
- status
- status_details
- workflow
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
number:
allOf:
- $ref: '#/components/schemas/BillingInvoiceNumber'
description: Human-readable invoice number generated by the invoicing app.
title: Number
readOnly: true
currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: Three-letter ISO 4217 currency code for the invoice.
title: Currency
readOnly: true
supplier:
allOf:
- $ref: '#/components/schemas/BillingSupplier'
description: |-
Snapshot of the supplier's contact information at the time the invoice was
issued.
title: Supplier
customer:
allOf:
- $ref: '#/components/schemas/BillingInvoiceCustomer'
description: Snapshot of the customer's information at the time the invoice was issued.
title: Customer
totals:
allOf:
- $ref: '#/components/schemas/BillingTotals'
description: Aggregated financial totals for the invoice.
title: Totals
readOnly: true
service_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: |-
The service period covered by this invoice.
For flat fee the service period can be empty which means `from` will be equals
to `to`. In other cases those fields will be filled with the actual service
period.
title: Service period
readOnly: true
validation_issues:
type: array
items:
$ref: '#/components/schemas/BillingInvoiceValidationIssue'
description: |-
Validation issues found during invoice processing.
Present only when there are one or more validation findings. An empty list is
omitted.
title: Validation issues
readOnly: true
external_references:
allOf:
- $ref: '#/components/schemas/BillingInvoiceExternalReferences'
description: External identifiers assigned to this invoice by third-party systems.
title: External references
readOnly: true
type:
type: string
enum:
- standard
description: Discriminator field identifying this as a standard invoice.
title: Type
status:
allOf:
- $ref: '#/components/schemas/BillingInvoiceStandardStatus'
description: Current lifecycle status of the invoice.
title: Status
readOnly: true
status_details:
allOf:
- $ref: '#/components/schemas/BillingInvoiceStatusDetails'
description: Detailed status information including available actions and workflow state.
title: Status details
readOnly: true
issued_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: Timestamp when the invoice was issued to the customer.
title: Issued at
readOnly: true
draft_until:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
Timestamp until which the invoice remains in draft state.
The invoice advances automatically once this time is reached.
title: Draft until
readOnly: true
quantity_snapshotted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: Timestamp when usage quantities were last snapshotted for this invoice.
title: Quantity snapshotted at
readOnly: true
collection_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: Timestamp when collection was initiated for this invoice.
title: Collection at
readOnly: true
due_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: Timestamp when payment is due.
title: Due at
readOnly: true
sent_to_customer_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: Timestamp when the invoice was sent to the customer.
title: Sent to customer at
readOnly: true
workflow:
allOf:
- $ref: '#/components/schemas/BillingInvoiceWorkflowSettings'
description: Workflow configuration snapshot captured at invoice creation time.
title: Workflow
lines:
type: array
items:
$ref: '#/components/schemas/BillingInvoiceLine'
description: |-
Line items on this invoice.
Always returned on single-resource GET; omitted on list endpoints unless
explicitly expanded. Editable via update: existing lines are matched by `id`,
lines without an `id` are created, and lines present on the invoice but omitted
from the update request are deleted. Detailed (child) lines are always computed
and cannot be edited directly.
title: Lines
additionalProperties: false
description: A standard invoice for charges owed by the customer.
BillingInvoiceStandardLine:
type: object
required:
- name
- created_at
- updated_at
- type
- lifecycle_controller
- service_period
- totals
- rate_card
- detailed_lines
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
id:
allOf:
- $ref: '#/components/schemas/ULID'
description: |-
ID of the line.
Optional on update: omit to create a new line, or supply the ID of an existing
line to edit it. Existing lines omitted from an update's `lines` array are
deleted.
title: ID
type:
type: string
enum:
- standard_line
description: The type of charge this line item represents.
title: Type
lifecycle_controller:
allOf:
- $ref: '#/components/schemas/BillingLifecycleController'
description: |-
Indicates whether this line item's lifecycle is controlled by OpenMeter or
manually overridden by the API user.
title: Lifecycle controller
readOnly: true
service_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: |-
The service period covered by this invoice, spanning the earliest line start to
the latest line end across all of its lines.
For an invoice with no lines the period is empty, which means `from` will be
equal to `to`.
title: Service period
totals:
allOf:
- $ref: '#/components/schemas/BillingTotals'
description: Aggregated financial totals for the line item.
title: Totals
readOnly: true
discounts:
allOf:
- $ref: '#/components/schemas/BillingInvoiceLineDiscounts'
description: Discounts applied to this line item.
title: Discounts
readOnly: true
credits_applied:
type: array
items:
$ref: '#/components/schemas/BillingInvoiceLineCreditsApplied'
description: Credit applied to this line item.
title: Credit applied
readOnly: true
external_references:
allOf:
- $ref: '#/components/schemas/BillingInvoiceLineExternalReferences'
description: External identifiers for this line item assigned by third-party systems.
title: External references
readOnly: true
subscription:
allOf:
- $ref: '#/components/schemas/BillingSubscriptionReference'
description: Reference to the subscription item that generated this line.
title: Subscription reference
readOnly: true
rate_card:
allOf:
- $ref: '#/components/schemas/BillingInvoiceLineRateCard'
description: The rate card configuration snapshot used to price this line item.
title: Rate card
detailed_lines:
type: array
items:
$ref: '#/components/schemas/BillingInvoiceDetailedLine'
description: |-
Detailed sub-lines that this line has been broken down into.
Present when line has individual details.
title: Detailed lines
readOnly: true
charge:
allOf:
- $ref: '#/components/schemas/BillingChargeReference'
description: Reference to the charge associated with this line item.
title: Charge
readOnly: true
additionalProperties: false
description: |-
A top-level line item on an invoice.
Each line represents a single charge, typically associated with a rate card from
a subscription. Detailed (child) lines are nested under `detailed_lines` when
present.
BillingInvoiceStandardStatus:
type: string
enum:
- draft
- issuing
- issued
- payment_processing
- overdue
- paid
- uncollectible
- voided
description: Lifecycle status of a standard invoice.
BillingInvoiceStatusDetails:
type: object
required:
- immutable
- failed
- extended_status
- available_actions
properties:
immutable:
type: boolean
description: Whether the invoice is immutable (i.e. cannot be modified or deleted).
title: Immutable
readOnly: true
failed:
type: boolean
description: Whether the invoice is in a failed state.
title: Failed
readOnly: true
extended_status:
type: string
description: |-
Fine-grained internal status string providing additional workflow detail beyond
the top-level status enum.
title: Extended status
readOnly: true
available_actions:
allOf:
- $ref: '#/components/schemas/BillingInvoiceAvailableActions'
description: The set of state-transition actions currently available for this invoice.
title: Available actions
readOnly: true
additionalProperties: false
description: Detailed status information for a standard invoice.
BillingInvoiceValidationIssue:
type: object
required:
- code
- message
- severity
properties:
code:
type: string
description: Machine-readable error code.
title: Code
readOnly: true
message:
type: string
description: Human-readable description of the error.
title: Message
readOnly: true
attributes:
type: object
additionalProperties: {}
description: Additional structured context.
title: Attributes
readOnly: true
severity:
allOf:
- $ref: '#/components/schemas/BillingInvoiceValidationIssueSeverity'
description: Severity of the validation issue.
title: Severity
readOnly: true
field:
type: string
description: |-
JSON path to the field that caused this validation issue, if applicable.
For example: `lines/0/rate_card/price`.
title: Field path
readOnly: true
additionalProperties: false
description: |-
A validation issue found during invoice processing.
Converges on the same structure used by plan and subscription validation errors:
a machine-readable `code`, a human-readable `message`, optional structured
`attributes`, plus a `severity` and optional `field` path.
BillingInvoiceValidationIssueSeverity:
type: string
enum:
- critical
- warning
description: Severity level of an invoice validation issue.
BillingInvoiceWorkflow:
type: object
properties:
invoicing:
allOf:
- $ref: '#/components/schemas/BillingInvoiceWorkflowInvoicingSettings'
description: Invoicing settings for this invoice.
title: Invoicing settings
payment:
allOf:
- $ref: '#/components/schemas/BillingWorkflowPaymentSettings'
description: Payment settings for this invoice.
title: Payment settings
additionalProperties: false
description: |-
Invoice-level snapshot of the workflow configuration.
Contains only the settings that are meaningful for an already-created invoice:
invoicing behaviour and payment settings. Collection alignment and tax policy
are gather-time / profile-wide concerns and are not included.
BillingInvoiceWorkflowAppsReferences:
type: object
required:
- tax
- invoicing
- payment
properties:
tax:
allOf:
- $ref: '#/components/schemas/BillingAppReference'
description: The tax app used for this workflow
readOnly: true
invoicing:
allOf:
- $ref: '#/components/schemas/BillingAppReference'
description: The invoicing app used for this workflow
readOnly: true
payment:
allOf:
- $ref: '#/components/schemas/BillingAppReference'
description: The payment app used for this workflow
readOnly: true
additionalProperties: false
description: |-
BillingInvoiceWorkflowAppsReferences represents the references (id) to the apps
used by a billing profile
BillingInvoiceWorkflowInvoicingSettings:
type: object
properties:
auto_advance:
type: boolean
description: Whether to automatically issue the invoice after the draft_period has passed.
default: true
draft_period:
type: string
format: ISO8601
description: The period for the invoice to be kept in draft status for manual reviews.
example: P1D
default: P0D
due_after:
type: string
format: ISO8601
description: The period after which the invoice is considered overdue if not paid.
example: P30D
readOnly: true
additionalProperties: false
description: |-
Invoice-level invoicing settings.
A subset of BillingWorkflowInvoicingSettings limited to fields that are
meaningful per-invoice. progressive_billing is omitted as it is a gather-time /
profile-level decision.
BillingInvoiceWorkflowSettings:
type: object
required:
- source_billing_profile
- workflow
properties:
apps:
allOf:
- $ref: '#/components/schemas/BillingInvoiceWorkflowAppsReferences'
description: The apps that will be used to orchestrate the invoice's workflow.
title: Application that generated the invoice
readOnly: true
source_billing_profile:
allOf:
- $ref: '#/components/schemas/BillingProfileReference'
description: The billing profile that was the source of this workflow snapshot.
title: Source billing profile
readOnly: true
workflow:
allOf:
- $ref: '#/components/schemas/BillingInvoiceWorkflow'
description: |-
The workflow configuration that was active when the invoice was created.
Only the fields that are meaningful at the per-invoice level are included:
invoicing behaviour (auto-advance, draft period) and payment settings
(collection method, due date). Profile-wide settings such as collection
alignment, progressive billing, and tax policy are omitted.
title: Workflow config
additionalProperties: false
description: Snapshot of the billing workflow configuration captured at invoice creation.
BillingLifecycleController:
type: string
enum:
- system
- manual
description: |-
Identifies whether a resource lifecycle is controlled by OpenMeter or manually
overridden by the API user.
Values:
- `system`: The resource lifecycle is controlled by OpenMeter.
- `manual`: The resource lifecycle was manually overridden by the API user.
title: Lifecycle controller
BillingParty:
type: object
properties:
id:
type: string
description: Unique identifier for the party.
readOnly: true
key:
allOf:
- $ref: '#/components/schemas/ExternalResourceKey'
description: An optional unique key of the party.
name:
type: string
description: Legal name or representation of the party.
tax_id:
allOf:
- $ref: '#/components/schemas/BillingPartyTaxIdentity'
description: |-
The entity's legal identification used for tax purposes. They may have other
numbers, but we're only interested in those valid for tax purposes.
addresses:
allOf:
- $ref: '#/components/schemas/BillingPartyAddresses'
description: Address for where information should be sent if needed.
additionalProperties: false
description: Party represents a person or business entity.
BillingPartyAddresses:
type: object
required:
- billing_address
properties:
billing_address:
allOf:
- $ref: '#/components/schemas/Address'
description: Billing address.
additionalProperties: false
description: A collection of addresses for the party.
BillingPartyTaxIdentity:
type: object
properties:
code:
allOf:
- $ref: '#/components/schemas/BillingTaxIdentificationCode'
description: Normalized tax identification code shown on the original identity document.
additionalProperties: false
description: |-
Identity stores the details required to identify an entity for tax purposes in a
specific country.
BillingPlan:
type: object
required:
- id
- name
- created_at
- updated_at
- key
- version
- currency
- billing_cadence
- status
- phases
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
key:
allOf:
- $ref: '#/components/schemas/ResourceKey'
description: |-
A key is a semi-unique string that is used to identify the plan. It is used to
reference the latest `active` version of the plan and is unique with the version
number.
title: Key
version:
type: integer
minimum: 1
description: |-
Plans are versioned to allow you to make changes without affecting running
subscriptions.
title: Version
default: 1
readOnly: true
currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: The currency code of the plan.
title: Currency
billing_cadence:
allOf:
- $ref: '#/components/schemas/ISO8601Duration'
description: The billing cadence for subscriptions using this plan.
title: Billing cadence
pro_rating_enabled:
type: boolean
description: Whether pro-rating is enabled for this plan.
title: Pro-rating enabled
default: true
effective_from:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
The date and time when the plan becomes `active`. When not specified, the plan
is in `draft` status.
title: Effective start date
readOnly: true
effective_to:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
A scheduled date and time when the plan becomes `archived`. When not specified,
the plan is in `active` status indefinitely.
title: Effective end date
readOnly: true
status:
allOf:
- $ref: '#/components/schemas/BillingPlanStatus'
description: |-
The status of the plan. Computed based on the effective start and end dates:
- `draft`: `effective_from` is not set.
- `scheduled`: `now < effective_from`.
- `active`: `effective_from <= now` and (`effective_to` is not set or
`now < effective_to`).
- `archived`: `effective_to <= now`.
title: Status
readOnly: true
phases:
type: array
items:
$ref: '#/components/schemas/BillingPlanPhase'
minItems: 1
description: |-
The plan phases define the pricing ramp for a subscription. A phase switch
occurs only at the end of a billing period. At least one phase is required.
title: Plan phases
settlement_mode:
allOf:
- $ref: '#/components/schemas/BillingSettlementMode'
description: |-
Settlement mode for plan.
Values:
- `credit_then_invoice`: Credits are applied first, then any remainder is
invoiced.
- `credit_only`: Usage is settled exclusively against credits.
title: Settlement Mode
default: credit_then_invoice
readOnly: true
validation_errors:
type: array
items:
$ref: '#/components/schemas/ProductCatalogValidationError'
description: |-
List of validation errors in `draft` state that prevent the plan from being
published.
title: Validation errors
readOnly: true
additionalProperties: false
description: Plans provide a template for subscriptions.
BillingPlanPhase:
type: object
required:
- name
- key
- rate_cards
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
key:
$ref: '#/components/schemas/ResourceKey'
duration:
allOf:
- $ref: '#/components/schemas/ISO8601Duration'
description: |-
The duration of the phase. When not specified, the phase runs indefinitely. Only
the last phase may omit the duration.
title: Duration
rate_cards:
type: array
items:
$ref: '#/components/schemas/BillingRateCard'
description: The rate cards of the plan.
title: Rate cards
additionalProperties: false
description: |-
The plan phase or pricing ramp allows changing a plan's rate cards over time as
a subscription progresses.
BillingPlanStatus:
type: string
enum:
- draft
- active
- archived
- scheduled
description: |-
The status of a plan.
- `draft`: The plan has not yet been published and can be edited.
- `active`: The plan is published and can be used in subscriptions.
- `archived`: The plan is no longer available for use.
- `scheduled`: The plan is scheduled to be published at a future date.
BillingPrice:
type: object
oneOf:
- $ref: '#/components/schemas/BillingPriceFree'
- $ref: '#/components/schemas/BillingPriceFlat'
- $ref: '#/components/schemas/BillingPriceUnit'
- $ref: '#/components/schemas/BillingPriceGraduated'
- $ref: '#/components/schemas/BillingPriceVolume'
discriminator:
propertyName: type
mapping:
free: '#/components/schemas/BillingPriceFree'
flat: '#/components/schemas/BillingPriceFlat'
unit: '#/components/schemas/BillingPriceUnit'
graduated: '#/components/schemas/BillingPriceGraduated'
volume: '#/components/schemas/BillingPriceVolume'
description: Price.
BillingPriceFlat:
type: object
required:
- type
- amount
properties:
type:
type: string
enum:
- flat
description: The type of the price.
title: Type
amount:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The amount of the flat price.
title: Amount
additionalProperties: false
description: Flat price.
BillingPriceFree:
type: object
required:
- type
properties:
type:
type: string
enum:
- free
description: The type of the price.
title: Type
additionalProperties: false
description: Free price.
BillingPriceGraduated:
type: object
required:
- type
- tiers
properties:
type:
type: string
enum:
- graduated
description: The type of the price.
title: Type
tiers:
type: array
items:
$ref: '#/components/schemas/BillingPriceTier'
minItems: 1
description: The tiers of the graduated price. At least one tier is required.
title: Tiers
additionalProperties: false
description: |-
Graduated tiered price.
Each tier's rate applies only to the usage within that tier. Pricing can change
as cumulative usage crosses tier boundaries.
When UnitConfig is present on the rate card, tier boundaries (up_to_amount) are
expressed in converted billing units.
BillingPricePaymentTerm:
type: string
enum:
- in_advance
- in_arrears
description: The payment term of a flat price.
BillingPriceTier:
type: object
properties:
up_to_amount:
allOf:
- $ref: '#/components/schemas/Numeric'
description: |-
Up to and including this quantity will be contained in the tier. If undefined,
the tier is open-ended (the last tier).
title: Up to quantity
flat_price:
allOf:
- $ref: '#/components/schemas/BillingPriceFlat'
description: The flat price component of the tier. Charged once when the tier is entered.
title: Flat price component
unit_price:
allOf:
- $ref: '#/components/schemas/BillingPriceUnit'
description: The unit price component of the tier. Charged per billing unit within the tier.
title: Unit price component
additionalProperties: false
description: |-
A price tier used in graduated and volume pricing.
At least one price component (flat_price or unit_price) must be set. When
UnitConfig is present on the rate card, up_to_amount is expressed in converted
billing units.
BillingPriceUnit:
type: object
required:
- type
- amount
properties:
type:
type: string
enum:
- unit
description: The type of the price.
title: Type
amount:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The amount of the unit price.
title: Amount
additionalProperties: false
description: |-
Unit price.
Charges a fixed rate per billing unit. When UnitConfig is present on the rate
card, billing units are the converted quantities (e.g. GB instead of bytes).
BillingPriceVolume:
type: object
required:
- type
- tiers
properties:
type:
type: string
enum:
- volume
description: The type of the price.
title: Type
tiers:
type: array
items:
$ref: '#/components/schemas/BillingPriceTier'
minItems: 1
description: The tiers of the volume price. At least one tier is required.
title: Tiers
additionalProperties: false
description: |-
Volume tiered price.
The maximum quantity within a period determines the per-unit price for all units
in that period.
When UnitConfig is present on the rate card, tier boundaries (up_to_amount) are
expressed in converted billing units.
BillingProfile:
type: object
required:
- id
- name
- created_at
- updated_at
- supplier
- workflow
- apps
- default
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
supplier:
allOf:
- $ref: '#/components/schemas/BillingParty'
description: |-
The name and contact information for the supplier this billing profile
represents
workflow:
allOf:
- $ref: '#/components/schemas/BillingWorkflow'
description: The billing workflow settings for this profile
apps:
allOf:
- $ref: '#/components/schemas/BillingProfileAppReferences'
description: The applications used by this billing profile.
default:
type: boolean
description: Whether this is the default profile.
additionalProperties: false
description: |-
Billing profiles contain the settings for billing and controls invoice
generation.
BillingProfileAppReferences:
type: object
required:
- tax
- invoicing
- payment
properties:
tax:
allOf:
- $ref: '#/components/schemas/BillingAppReference'
description: The tax app used for this workflow.
invoicing:
allOf:
- $ref: '#/components/schemas/BillingAppReference'
description: The invoicing app used for this workflow.
payment:
allOf:
- $ref: '#/components/schemas/BillingAppReference'
description: The payment app used for this workflow.
additionalProperties: false
description: References to the applications used by a billing profile.
BillingProfilePagePaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/BillingProfile'
meta:
$ref: '#/components/schemas/PaginatedMeta'
additionalProperties: false
description: Page paginated response.
BillingProfileReference:
type: object
required:
- id
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
description: The ID of the billing profile.
additionalProperties: false
description: Billing profile reference.
BillingRateCard:
type: object
required:
- name
- key
- price
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
key:
$ref: '#/components/schemas/ResourceKey'
feature:
allOf:
- $ref: '#/components/schemas/FeatureReference'
description: The feature associated with the rate card.
title: Feature reference
billing_cadence:
allOf:
- $ref: '#/components/schemas/ISO8601Duration'
description: |-
The billing cadence of the rate card. When null, the charge is one-time
(non-recurring). Only valid for flat prices.
title: Billing cadence
price:
allOf:
- $ref: '#/components/schemas/BillingPrice'
description: The price of the rate card.
title: Price
unit_config:
allOf:
- $ref: '#/components/schemas/BillingUnitConfig'
description: |-
Unit conversion configuration for the rate card.
Synthesized on read for plans authored with v1 dynamic or package prices:
dynamic prices map to a unit price with a multiply unit config, and package
prices map to a unit price with a divide unit config.
Accepted on create and update only when the UnitConfig feature is enabled on the
deployment; otherwise rejected.
title: Unit config
payment_term:
allOf:
- $ref: '#/components/schemas/BillingPricePaymentTerm'
description: |-
The payment term of the rate card. In advance payment term can only be used for
flat prices.
title: Payment term
default: in_arrears
commitments:
allOf:
- $ref: '#/components/schemas/BillingSpendCommitments'
description: |-
Spend commitments for this rate card. Only applicable to usage-based prices
(unit, graduated, volume).
title: Commitments
discounts:
allOf:
- $ref: '#/components/schemas/BillingRateCardDiscounts'
description: The discounts of the rate card.
title: Discounts
tax_config:
allOf:
- $ref: '#/components/schemas/BillingRateCardTaxConfig'
description: The tax config of the rate card.
title: Tax config
entitlement:
allOf:
- $ref: '#/components/schemas/BillingRateCardEntitlement'
description: |-
The entitlement template granted to subscribers of a plan or addon containing
this rate card. Requires `feature` to be set.
title: Entitlement template
additionalProperties: false
description: A rate card defines the pricing and entitlement of a feature or service.
BillingRateCardBooleanEntitlement:
type: object
required:
- type
properties:
type:
type: string
enum:
- boolean
description: The type of the entitlement template.
title: Type
additionalProperties: false
description: The entitlement template of a boolean entitlement.
BillingRateCardDiscounts:
type: object
properties:
percentage:
type: number
minimum: 0
maximum: 100
description: Percentage discount applied to the price (0–100).
usage:
allOf:
- $ref: '#/components/schemas/Numeric'
description: |-
Number of usage units granted free before billing starts. Only applies to
usage-based lines (not flat fees). Usage is treated as zero until this amount is
exhausted.
additionalProperties: false
description: Discount configuration for a rate card.
BillingRateCardEntitlement:
type: object
oneOf:
- $ref: '#/components/schemas/BillingRateCardMeteredEntitlement'
- $ref: '#/components/schemas/BillingRateCardStaticEntitlement'
- $ref: '#/components/schemas/BillingRateCardBooleanEntitlement'
discriminator:
propertyName: type
mapping:
metered: '#/components/schemas/BillingRateCardMeteredEntitlement'
static: '#/components/schemas/BillingRateCardStaticEntitlement'
boolean: '#/components/schemas/BillingRateCardBooleanEntitlement'
description: |-
Entitlement template configured on a rate card. The feature is taken from the
rate card itself, so it is omitted here.
BillingRateCardMeteredEntitlement:
type: object
required:
- type
properties:
type:
type: string
enum:
- metered
description: The type of the entitlement template.
title: Type
is_soft_limit:
type: boolean
description: |-
If soft limit is true, the subject can use the feature even if the entitlement
is exhausted; access remains granted.
title: Soft limit
default: false
limit:
type: number
format: double
minimum: 0
description: |-
The amount of usage granted each usage period, in the feature's unit. Usage is
counted against this allowance and the balance resets every usage period. When
`is_soft_limit` is true the subject keeps access after the limit is reached;
otherwise access is denied once the allowance is exhausted.
title: Usage limit
usage_period:
allOf:
- $ref: '#/components/schemas/ISO8601Duration'
description: |-
The reset interval of the metered entitlement in ISO8601 format. Defaults to the
billing cadence of the rate card.
title: Usage period
additionalProperties: false
description: The entitlement template of a metered entitlement.
BillingRateCardProrationConfiguration:
type: object
required:
- mode
properties:
mode:
allOf:
- $ref: '#/components/schemas/BillingRateCardProrationMode'
description: The proration mode of the rate card.
title: Proration mode
additionalProperties: false
description: The proration configuration of the rate card.
BillingRateCardProrationMode:
type: string
enum:
- no_proration
- prorate_prices
description: |-
The proration mode of the rate card.
Values:
- `no_proration`: No proration.
- `prorate_prices`: Prorate the price based on the time remaining in the billing
period.
BillingRateCardStaticEntitlement:
type: object
required:
- type
- config
properties:
type:
type: string
enum:
- static
description: The type of the entitlement template.
title: Type
config:
description: |-
The entitlement config as a JSON object. Returned when checking entitlement
access; useful for configuring fine-grained access settings implemented in your
own system.
title: Config
additionalProperties: false
description: The entitlement template of a static entitlement.
BillingRateCardTaxConfig:
type: object
required:
- code
properties:
behavior:
$ref: '#/components/schemas/BillingTaxBehavior'
code:
$ref: '#/components/schemas/TaxCodeReference'
additionalProperties: false
description: The tax config of the rate card.
BillingSettlementMode:
type: string
enum:
- credit_then_invoice
- credit_only
description: |-
Settlement mode for billing.
Values:
- `credit_then_invoice`: Credits are applied first, then any remainder is
invoiced.
- `credit_only`: Usage is settled exclusively against credits.
title: Settlement mode
BillingSpendCommitments:
type: object
properties:
minimum_amount:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The customer is committed to spend at least the amount.
title: Minimum amount
maximum_amount:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The customer is limited to spend at most the amount.
title: Maximum amount
additionalProperties: false
description: |-
Spend commitments for a rate card. The customer is committed to spend at least
the minimum amount and at most the maximum amount.
BillingSubscription:
type: object
required:
- id
- created_at
- updated_at
- customer_id
- billing_anchor
- status
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
customer_id:
allOf:
- $ref: '#/components/schemas/ULID'
description: The customer ID of the subscription.
title: Customer ID
readOnly: true
plan_id:
allOf:
- $ref: '#/components/schemas/ULID'
description: The plan ID of the subscription. Set if subscription is created from a plan.
title: Plan ID
readOnly: true
billing_anchor:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
A billing anchor is the fixed point in time that determines the subscription's
recurring billing cycle. It affects when charges occur and how prorations are
calculated. Common anchors:
- Calendar month (1st of each month): `2025-01-01T00:00:00Z`
- Subscription anniversary (day customer signed up)
- Custom date (customer-specified day)
title: Billing anchor
readOnly: true
status:
allOf:
- $ref: '#/components/schemas/BillingSubscriptionStatus'
description: The status of the subscription.
title: Status
readOnly: true
settlement_mode:
allOf:
- $ref: '#/components/schemas/BillingSettlementMode'
description: |-
Settlement mode for billing.
Values:
- `credit_then_invoice`: Credits are applied first, then any remainder is
invoiced.
- `credit_only`: Usage is settled exclusively against credits.
title: Settlement Mode
additionalProperties: false
description: Subscription.
BillingSubscriptionCancel:
type: object
properties:
timing:
allOf:
- $ref: '#/components/schemas/BillingSubscriptionEditTiming'
description: If not provided the subscription is canceled immediately.
default: immediate
additionalProperties: false
description: Request for canceling a subscription.
BillingSubscriptionChange:
type: object
required:
- customer
- plan
- timing
properties:
labels:
$ref: '#/components/schemas/Labels'
settlement_mode:
allOf:
- $ref: '#/components/schemas/BillingSettlementMode'
description: |-
Settlement mode for billing.
Values:
- `credit_then_invoice`: Credits are applied first, then any remainder is
invoiced.
- `credit_only`: Usage is settled exclusively against credits.
title: Settlement Mode
customer:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
description: |-
The ID of the customer to create the subscription for.
Either customer ID or customer key must be provided. If both are provided, the
ID will be used.
title: Customer ID
key:
allOf:
- $ref: '#/components/schemas/ExternalResourceKey'
description: |-
The key of the customer to create the subscription for.
Either customer ID or customer key must be provided. If both are provided, the
ID will be used.
title: Customer Key
additionalProperties: false
description: The customer to create the subscription for.
plan:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
description: |-
The plan ID of the subscription. Set if subscription is created from a plan.
ID or Key of the plan is required if creating a subscription from a plan. If
both are provided, the ID will be used.
title: Plan ID
key:
allOf:
- $ref: '#/components/schemas/ResourceKey'
description: |-
The plan Key of the subscription, if any. Set if subscription is created from a
plan.
ID or Key of the plan is required if creating a subscription from a plan. If
both are provided, the ID will be used.
title: Plan Key
version:
type: integer
description: |-
The plan version of the subscription, if any. If not provided, the latest
version of the plan will be used.
title: Plan Version
additionalProperties: false
description: The plan reference of the subscription.
billing_anchor:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
A billing anchor is the fixed point in time that determines the subscription's
recurring billing cycle. It affects when charges occur and how prorations are
calculated. Common anchors:
- Calendar month (1st of each month): `2025-01-01T00:00:00Z`
- Subscription anniversary (day customer signed up)
- Custom date (customer-specified day)
If not provided, the subscription will be created with the subscription's
creation time as the billing anchor.
title: Billing anchor
timing:
allOf:
- $ref: '#/components/schemas/BillingSubscriptionEditTiming'
description: |-
Timing configuration for the change, when the change should take effect. For
changing a subscription, the accepted values depend on the subscription
configuration.
additionalProperties: false
description: Request for changing a subscription.
BillingSubscriptionChangeResponse:
type: object
required:
- current
- next
properties:
current:
allOf:
- $ref: '#/components/schemas/BillingSubscription'
description: The current subscription before the change.
next:
allOf:
- $ref: '#/components/schemas/BillingSubscription'
description: The new state of the subscription after the change.
additionalProperties: false
description: Response for changing a subscription.
BillingSubscriptionCreate:
type: object
required:
- customer
- plan
properties:
labels:
$ref: '#/components/schemas/Labels'
settlement_mode:
allOf:
- $ref: '#/components/schemas/BillingSettlementMode'
description: |-
Settlement mode for billing.
Values:
- `credit_then_invoice`: Credits are applied first, then any remainder is
invoiced.
- `credit_only`: Usage is settled exclusively against credits.
title: Settlement Mode
customer:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
description: |-
The ID of the customer to create the subscription for.
Either customer ID or customer key must be provided. If both are provided, the
ID will be used.
title: Customer ID
key:
allOf:
- $ref: '#/components/schemas/ExternalResourceKey'
description: |-
The key of the customer to create the subscription for.
Either customer ID or customer key must be provided. If both are provided, the
ID will be used.
title: Customer Key
additionalProperties: false
description: The customer to create the subscription for.
plan:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
description: |-
The plan ID of the subscription. Set if subscription is created from a plan.
ID or Key of the plan is required if creating a subscription from a plan. If
both are provided, the ID will be used.
title: Plan ID
key:
allOf:
- $ref: '#/components/schemas/ResourceKey'
description: |-
The plan Key of the subscription, if any. Set if subscription is created from a
plan.
ID or Key of the plan is required if creating a subscription from a plan. If
both are provided, the ID will be used.
title: Plan Key
version:
type: integer
description: |-
The plan version of the subscription, if any. If not provided, the latest
version of the plan will be used.
title: Plan Version
additionalProperties: false
description: The plan reference of the subscription.
billing_anchor:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
A billing anchor is the fixed point in time that determines the subscription's
recurring billing cycle. It affects when charges occur and how prorations are
calculated. Common anchors:
- Calendar month (1st of each month): `2025-01-01T00:00:00Z`
- Subscription anniversary (day customer signed up)
- Custom date (customer-specified day)
If not provided, the subscription will be created with the subscription's
creation time as the billing anchor.
title: Billing anchor
additionalProperties: false
description: Subscription create request.
BillingSubscriptionEditTiming:
oneOf:
- $ref: '#/components/schemas/BillingSubscriptionEditTimingEnum'
- $ref: '#/components/schemas/DateTime'
description: |-
Subscription edit timing defined when the changes should take effect. If the
provided configuration is not supported by the subscription, an error will be
returned.
example: immediate
BillingSubscriptionEditTimingEnum:
type: string
enum:
- immediate
- next_billing_cycle
description: |-
Subscription edit timing. When immediate, the requested changes take effect
immediately. When next_billing_cycle, the requested changes take effect at the
next billing cycle.
BillingSubscriptionReference:
type: object
required:
- id
- phase
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
description: The ID of the subscription.
title: Subscription ID
readOnly: true
phase:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
description: The ID of the phase.
title: Phase ID
readOnly: true
item:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
description: The ID of the item.
title: Item ID
readOnly: true
required:
- id
additionalProperties: false
description: The item of the phase.
title: Item ID
readOnly: true
required:
- id
- item
additionalProperties: false
description: The phase of the subscription.
title: Phase ID
readOnly: true
additionalProperties: false
description: |-
Subscription reference represents a reference to the specific subscription item
this entity represents.
BillingSubscriptionStatus:
type: string
enum:
- active
- inactive
- canceled
- scheduled
description: Subscription status.
BillingSupplier:
type: object
properties:
name:
type: string
description: Legal name or representation of the party.
tax_id:
allOf:
- $ref: '#/components/schemas/BillingPartyTaxIdentity'
description: |-
The entity's legal identification used for tax purposes. They may have other
numbers, but we're only interested in those valid for tax purposes.
addresses:
allOf:
- $ref: '#/components/schemas/BillingPartyAddresses'
description: Address for where information should be sent if needed.
id:
type: string
description: Unique identifier for the party.
additionalProperties: false
description: |-
Snapshot of the supplier's information at the time the invoice was issued.
Structurally a read-only subset of `BillingParty` (the type configured on the
billing profile), so the snapshot stays aligned with the source. `key` is
omitted because it is not part of the snapshotted supplier data.
BillingTaxBehavior:
type: string
enum:
- inclusive
- exclusive
description: |-
Tax behavior.
This enum is used to specify whether tax is included in the price or excluded
from the price.
BillingTaxCode:
type: object
required:
- id
- name
- created_at
- updated_at
- key
- app_mappings
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
key:
$ref: '#/components/schemas/ResourceKey'
app_mappings:
type: array
items:
$ref: '#/components/schemas/BillingTaxCodeAppMapping'
description: Mapping of app types to tax codes.
title: App type to tax code mappings
additionalProperties: false
description: Tax codes by provider.
BillingTaxCodeAppMapping:
type: object
required:
- app_type
- tax_code
properties:
app_type:
allOf:
- $ref: '#/components/schemas/BillingAppType'
description: The app type that the tax code is associated with.
title: App type
tax_code:
type: string
description: Tax code.
title: Tax code
additionalProperties: false
description: Mapping of app types to tax codes.
BillingTaxConfig:
type: object
properties:
behavior:
allOf:
- $ref: '#/components/schemas/BillingTaxBehavior'
description: |-
Tax behavior.
If not specified the billing profile is used to determine the tax behavior. If
not specified in the billing profile, the provider's default behavior is used.
title: Tax behavior
stripe:
allOf:
- $ref: '#/components/schemas/BillingTaxConfigStripe'
description: Stripe tax config.
title: Stripe tax config
deprecated: true
external_invoicing:
allOf:
- $ref: '#/components/schemas/BillingTaxConfigExternalInvoicing'
description: External invoicing tax config.
title: External invoicing tax config
deprecated: true
tax_code_id:
allOf:
- $ref: '#/components/schemas/ULID'
description: Tax code ID.
title: Tax code ID
deprecated: true
tax_code:
allOf:
- $ref: '#/components/schemas/TaxCodeReference'
description: |-
Tax code reference.
When both `tax_code` and `tax_code_id` are provided, `tax_code` takes
precedence. When `stripe.code` is also provided, `tax_code` still wins and
`stripe.code` is ignored.
title: Tax code
additionalProperties: false
description: Set of provider specific tax configs.
BillingTaxConfigExternalInvoicing:
type: object
required:
- code
properties:
code:
type: string
maxLength: 64
description: The tax code should be interpreted by the external invoicing provider.
title: Tax code
additionalProperties: false
description: External invoicing tax config.
BillingTaxConfigStripe:
type: object
required:
- code
properties:
code:
type: string
pattern: ^txcd_\d{8}$
description: Product [tax code](https://docs.stripe.com/tax/tax-codes).
title: Tax code
example: txcd_10000000
additionalProperties: false
description: The tax config for Stripe.
BillingTaxIdentificationCode:
type: string
minLength: 1
maxLength: 32
description: |-
Tax identifier code is a normalized tax code shown on the original identity
document.
BillingTotals:
type: object
required:
- amount
- taxes_total
- taxes_inclusive_total
- taxes_exclusive_total
- charges_total
- discounts_total
- credits_total
- total
properties:
amount:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The total value of the resource before taxes, discounts and commitments.
title: Amount
readOnly: true
taxes_total:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The total tax amount applied to the resource.
title: Taxes total
readOnly: true
taxes_inclusive_total:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The total tax amount already included in the resource amount.
title: Inclusive taxes total
readOnly: true
taxes_exclusive_total:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The total tax amount added on top of the resource amount.
title: Exclusive taxes total
readOnly: true
charges_total:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The total amount contributed by additional charges.
title: Charges total
readOnly: true
discounts_total:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The total amount deducted through discounts.
title: Discounts total
readOnly: true
credits_total:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The total amount deducted through credits before taxes are applied.
title: Credits total
readOnly: true
total:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The final total value of the resource after taxes, discounts and commitments.
title: Total
readOnly: true
additionalProperties: false
description: Totals contains the summaries of all calculations for a billing resource.
BillingUnitConfig:
type: object
required:
- operation
- conversion_factor
properties:
operation:
allOf:
- $ref: '#/components/schemas/BillingUnitConfigOperation'
description: The arithmetic operation to apply to the raw metered quantity.
title: Conversion operation
conversion_factor:
allOf:
- $ref: '#/components/schemas/Numeric'
description: |-
The factor used in the conversion operation.
- For `divide`: `converted = raw / conversionFactor`.
- For `multiply`: `converted = raw × conversionFactor`.
Must be a positive non-zero value.
title: Conversion factor
rounding:
allOf:
- $ref: '#/components/schemas/BillingUnitConfigRoundingMode'
description: |-
The rounding mode applied to the converted quantity for invoicing.
Defaults to none (no rounding). Entitlement checks always use the precise
(unrounded) value.
title: Rounding mode
default: none
precision:
type: integer
description: |-
The number of decimal places to retain after rounding.
Only meaningful when rounding is not "none". Defaults to 0 (round to whole
numbers).
title: Rounding precision (decimal places)
default: 0
display_unit:
type: string
description: |-
A human-readable label for the converted unit shown on invoices and in the
customer portal (e.g., "GB", "hours", "M tokens").
Optional. When omitted, no unit label is rendered.
title: Display unit label
additionalProperties: false
description: |-
Unit conversion configuration.
Transforms raw metered quantities into billing-ready units before pricing and
entitlement evaluation. Applied at the rate card level so the same feature can
be billed in different units across plans.
Examples:
- Meter bytes, bill GB: operation=divide, conversionFactor=1e9,
rounding=ceiling, displayUnit="GB"
- Meter seconds, bill hours: operation=divide, conversionFactor=3600,
rounding=ceiling, displayUnit="hours"
- Cost + 20% margin: operation=multiply, conversionFactor=1.2
- Bill per million tokens: operation=divide, conversionFactor=1e6,
rounding=ceiling, displayUnit="M"
v1 equivalents:
- DynamicPrice(multiplier): operation=multiply, conversionFactor=multiplier +
UnitPrice(amount=1)
- PackagePrice(amount, quantityPerPkg): operation=divide,
conversionFactor=quantityPerPkg, rounding=ceiling + UnitPrice(amount)
BillingUnitConfigOperation:
type: string
enum:
- divide
- multiply
description: |-
The arithmetic operation used to convert raw metered units into billing units.
- `divide`: Divide the metered quantity by the conversion factor (e.g., bytes ÷
1e9 = GB).
- `multiply`: Multiply the metered quantity by the conversion factor (e.g., cost
× 1.2 = cost + 20% margin).
BillingUnitConfigRoundingMode:
type: string
enum:
- ceiling
- floor
- half_up
- none
description: |-
The rounding mode applied to the converted quantity for invoicing.
Rounding is applied only to the invoiced quantity. Entitlement balance checks
use the precise decimal value after conversion.
- `ceiling`: Round up to the next integer (typical for package-style billing).
- `floor`: Round down to the previous integer.
- `half_up`: Round to the nearest integer, with 0.5 rounding up.
- `none`: No rounding; the converted value is used as-is.
BillingWorkflow:
type: object
properties:
collection:
allOf:
- $ref: '#/components/schemas/BillingWorkflowCollectionSettings'
description: The collection settings for this workflow
invoicing:
allOf:
- $ref: '#/components/schemas/BillingWorkflowInvoicingSettings'
description: The invoicing settings for this workflow
payment:
allOf:
- $ref: '#/components/schemas/BillingWorkflowPaymentSettings'
description: The payment settings for this workflow
tax:
allOf:
- $ref: '#/components/schemas/BillingWorkflowTaxSettings'
description: The tax settings for this workflow
additionalProperties: false
description: Billing workflow settings.
BillingWorkflowCollectionAlignment:
type: object
oneOf:
- $ref: '#/components/schemas/BillingWorkflowCollectionAlignmentSubscription'
- $ref: '#/components/schemas/BillingWorkflowCollectionAlignmentAnchored'
discriminator:
propertyName: type
mapping:
subscription: '#/components/schemas/BillingWorkflowCollectionAlignmentSubscription'
anchored: '#/components/schemas/BillingWorkflowCollectionAlignmentAnchored'
description: |-
The alignment for collecting the pending line items into an invoice.
Defaults to subscription, which means that we are to create a new invoice every
time the a subscription period starts (for in advance items) or ends (for in
arrears items).
BillingWorkflowCollectionAlignmentAnchored:
type: object
required:
- type
- recurring_period
properties:
type:
type: string
enum:
- anchored
description: The type of alignment.
recurring_period:
allOf:
- $ref: '#/components/schemas/RecurringPeriod'
description: The recurring period for the alignment.
additionalProperties: false
description: |-
BillingWorkflowCollectionAlignmentAnchored specifies the alignment for
collecting the pending line items into an invoice.
BillingWorkflowCollectionAlignmentSubscription:
type: object
required:
- type
properties:
type:
type: string
enum:
- subscription
description: The type of alignment.
additionalProperties: false
description: |-
BillingWorkflowCollectionAlignmentSubscription specifies the alignment for
collecting the pending line items into an invoice.
BillingWorkflowCollectionSettings:
type: object
properties:
alignment:
allOf:
- $ref: '#/components/schemas/BillingWorkflowCollectionAlignment'
description: The alignment for collecting the pending line items into an invoice.
default:
type: subscription
interval:
type: string
format: ISO8601
description: |-
This grace period can be used to delay the collection of the pending line items
specified in alignment.
This is useful, in case of multiple subscriptions having slightly different
billing periods.
example: P1D
default: PT1H
additionalProperties: false
description: |-
Workflow collection specifies how to collect the pending line items for an
invoice.
title: Workflow collection settings
BillingWorkflowInvoicingSettings:
type: object
properties:
auto_advance:
type: boolean
description: Whether to automatically issue the invoice after the draftPeriod has passed.
default: true
draft_period:
type: string
format: ISO8601
description: The period for the invoice to be kept in draft status for manual reviews.
example: P1D
default: P0D
progressive_billing:
type: boolean
description: Should progressive billing be allowed for this workflow?
default: true
subscription_end_proration_mode:
allOf:
- $ref: '#/components/schemas/BillingWorkflowInvoicingSubscriptionEndProrationMode'
description: Controls how subscription-ending shortened service periods are billed.
default: bill_actual_period
additionalProperties: false
description: Invoice settings for a billing workflow.
title: Workflow invoice settings
BillingWorkflowInvoicingSubscriptionEndProrationMode:
type: string
enum:
- bill_full_period
- bill_actual_period
description: Billing workflow subscription end proration mode.
BillingWorkflowPaymentChargeAutomaticallySettings:
type: object
required:
- collection_method
properties:
collection_method:
type: string
enum:
- charge_automatically
description: The collection method for the invoice.
additionalProperties: false
description: |-
Payment settings for a billing workflow when the collection method is charge
automatically.
BillingWorkflowPaymentSendInvoiceSettings:
type: object
required:
- collection_method
properties:
collection_method:
type: string
enum:
- send_invoice
description: The collection method for the invoice.
due_after:
type: string
format: ISO8601
description: |-
The period after which the invoice is due. With some payment solutions it's only
applicable for manual collection method.
example: P30D
default: P30D
additionalProperties: false
description: |-
Payment settings for a billing workflow when the collection method is send
invoice.
BillingWorkflowPaymentSettings:
type: object
oneOf:
- $ref: '#/components/schemas/BillingWorkflowPaymentChargeAutomaticallySettings'
- $ref: '#/components/schemas/BillingWorkflowPaymentSendInvoiceSettings'
discriminator:
propertyName: collection_method
mapping:
charge_automatically: '#/components/schemas/BillingWorkflowPaymentChargeAutomaticallySettings'
send_invoice: '#/components/schemas/BillingWorkflowPaymentSendInvoiceSettings'
description: Payment settings for a billing workflow.
BillingWorkflowTaxSettings:
type: object
properties:
enabled:
type: boolean
description: |-
Enable automatic tax calculation when tax is supported by the app. For example,
with Stripe Invoicing when enabled, tax is calculated via Stripe Tax.
default: true
enforced:
type: boolean
description: |-
Enforce tax calculation when tax is supported by the app. When enabled, the
billing system will not allow to create an invoice without tax calculation.
Enforcement is different per apps, for example, Stripe app requires customer to
have a tax location when starting a paid subscription.
default: false
default_tax_config:
allOf:
- $ref: '#/components/schemas/BillingTaxConfig'
description: |-
Default tax configuration to apply to the invoices for line items.
Setting a tax code (`stripe.code` / `taxCodeId`) on a profile's default tax
config is deprecated and can no longer be added or changed: the organization
default tax code is used instead. Existing tax-code values may still be removed,
and `behavior` remains fully supported.
additionalProperties: false
description: Tax settings for a billing workflow.
title: Workflow tax settings
ChargePagePaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/BillingCharge'
meta:
$ref: '#/components/schemas/PaginatedMeta'
additionalProperties: false
description: Page paginated response.
ClosedPeriod:
type: object
required:
- from
- to
properties:
from:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
The start of the period.
The period is inclusive at the start.
title: Start
example: '2023-01-01T01:01:01.001Z'
to:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
The end of the period.
The period is exclusive at the end.
title: End
example: '2023-01-01T01:01:01.001Z'
additionalProperties: false
description: |-
A period with defined start and end dates.
The period is always inclusive at the start and exclusive at the end.
CostBasisPagePaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/BillingCostBasis'
meta:
$ref: '#/components/schemas/PaginatedMeta'
additionalProperties: false
description: Page paginated response.
CountryCode:
type: string
minLength: 2
maxLength: 2
pattern: ^[A-Z]{2}$
description: |-
[ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-2 country
code. Custom two-letter country codes are also supported for convenience.
example: US
CreateAddonRequest:
type: object
required:
- name
- key
- instance_type
- currency
- rate_cards
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
key:
allOf:
- $ref: '#/components/schemas/ResourceKey'
description: |-
A key is a semi-unique string that is used to identify the add-on. It is used to
reference the latest `active` version of the add-on and is unique with the
version number.
title: Key
instance_type:
allOf:
- $ref: '#/components/schemas/AddonInstanceType'
description: The InstanceType of the add-ons. Can be "single" or "multiple".
title: The InstanceType of the add-ons. Can be "single" or "multiple".
currency:
allOf:
- $ref: '#/components/schemas/BillingCurrencyCode'
description: The currency code of the add-on.
title: Currency
rate_cards:
type: array
items:
$ref: '#/components/schemas/BillingRateCard'
description: The rate cards of the add-on.
title: Rate cards
additionalProperties: false
description: Addon create request.
CreateBillingProfileRequest:
type: object
required:
- name
- supplier
- workflow
- apps
- default
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
supplier:
allOf:
- $ref: '#/components/schemas/BillingParty'
description: |-
The name and contact information for the supplier this billing profile
represents
workflow:
allOf:
- $ref: '#/components/schemas/BillingWorkflow'
description: The billing workflow settings for this profile
apps:
allOf:
- $ref: '#/components/schemas/BillingProfileAppReferences'
description: The applications used by this billing profile.
default:
type: boolean
description: Whether this is the default profile.
additionalProperties: false
description: BillingProfile create request.
CreateChargeFlatFeeRequest:
type: object
required:
- name
- type
- currency
- invoice_at
- service_period
- settlement_mode
- payment_term
- proration_configuration
- amount_before_proration
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
type:
type: string
enum:
- flat_fee
description: The type of the charge.
title: Type
currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: The currency of the charge.
title: Currency
invoice_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: The timestamp when the charge is intended to be invoiced.
title: Invoice at
service_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The effective service period covered by the charge.
title: Service period
unique_reference_id:
type: string
description: Unique reference ID of the charge.
title: Unique reference ID
settlement_mode:
allOf:
- $ref: '#/components/schemas/BillingSettlementMode'
description: Settlement mode of the charge.
title: Settlement mode
tax_config:
allOf:
- $ref: '#/components/schemas/BillingTaxConfig'
description: Tax configuration of the charge.
title: Tax configuration
payment_term:
allOf:
- $ref: '#/components/schemas/BillingPricePaymentTerm'
description: Payment term of the flat fee charge.
title: Payment term
discounts:
allOf:
- $ref: '#/components/schemas/BillingChargeFlatFeeDiscounts'
description: The discounts applied to the charge.
title: Discounts
feature_key:
type: string
description: The feature associated with the charge, when applicable.
title: Feature key
proration_configuration:
allOf:
- $ref: '#/components/schemas/BillingRateCardProrationConfiguration'
description: The proration configuration of the charge.
title: Proration configuration
amount_before_proration:
allOf:
- $ref: '#/components/schemas/CurrencyAmount'
description: The amount before proration of the charge.
title: Amount before proration
full_service_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The full, unprorated service period of the charge.
title: Full service period
billing_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The billing period the charge belongs to.
title: Billing period
additionalProperties: false
description: Flat fee charge create request.
CreateChargeRequest:
type: object
oneOf:
- $ref: '#/components/schemas/CreateChargeFlatFeeRequest'
- $ref: '#/components/schemas/CreateChargeUsageBasedRequest'
discriminator:
propertyName: type
mapping:
flat_fee: '#/components/schemas/CreateChargeFlatFeeRequest'
usage_based: '#/components/schemas/CreateChargeUsageBasedRequest'
description: Customer charge.
title: Customer charge create request.
CreateChargeUsageBasedRequest:
type: object
required:
- name
- type
- currency
- invoice_at
- service_period
- settlement_mode
- feature_key
- price
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
type:
type: string
enum:
- usage_based
description: The type of the charge.
title: Type
currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: The currency of the charge.
title: Currency
invoice_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: The timestamp when the charge is intended to be invoiced.
title: Invoice at
service_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The effective service period covered by the charge.
title: Service period
unique_reference_id:
type: string
description: Unique reference ID of the charge.
title: Unique reference ID
settlement_mode:
allOf:
- $ref: '#/components/schemas/BillingSettlementMode'
description: Settlement mode of the charge.
title: Settlement mode
tax_config:
allOf:
- $ref: '#/components/schemas/BillingTaxConfig'
description: Tax configuration of the charge.
title: Tax configuration
discounts:
allOf:
- $ref: '#/components/schemas/BillingRateCardDiscounts'
description: Discounts applied to the usage-based charge.
title: Discounts
feature_key:
type: string
description: The feature associated with the charge.
title: Feature key
price:
allOf:
- $ref: '#/components/schemas/BillingPrice'
description: The price of the charge.
title: Price
full_service_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The full, unprorated service period of the charge.
title: Full service period
billing_period:
allOf:
- $ref: '#/components/schemas/ClosedPeriod'
description: The billing period the charge belongs to.
title: Billing period
additionalProperties: false
description: Usage-based charge create request.
CreateCostBasisRequest:
type: object
required:
- fiat_code
- rate
properties:
fiat_code:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: The fiat currency code for the cost basis.
rate:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The cost rate for the currency.
effective_from:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
An ISO-8601 timestamp representation of the date from which the cost basis is
effective. If not provided, it will be effective immediately and will be set to
`now` by the system.
effective_to:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
An ISO-8601 timestamp representation of the date until which the cost basis is
effective. If provided, it must be later than `effective_from`. If not provided,
it remains effective until superseded.
additionalProperties: false
description: CostBasis create request.
CreateCreditAdjustmentRequest:
type: object
required:
- name
- currency
- amount
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
currency:
allOf:
- $ref: '#/components/schemas/BillingCurrencyCode'
description: The currency of the granted credits.
amount:
allOf:
- $ref: '#/components/schemas/Numeric'
description: Granted credit amount.
additionalProperties: false
description: CreditAdjustment create request.
CreateCreditGrantFilters:
type: object
properties:
features:
type: array
items:
$ref: '#/components/schemas/ResourceKey'
description: |-
Limit the credit grant to specific features. If no features are specified, the
credit grant can be used for any feature.
example:
- input_tokens
- output_tokens
additionalProperties: false
description: Filters for the credit grant.
CreateCreditGrantPurchase:
type: object
required:
- currency
properties:
currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: Currency of the purchase amount.
per_unit_cost_basis:
allOf:
- $ref: '#/components/schemas/Numeric'
description: |-
Cost basis per credit unit used to calculate the purchase amount.
If `per_unit_cost_basis` is 0.50 and credit amount is $100.00, the total charge
is $50.00. The value must be greater than 0. If the cost basis is 0, use
`funding_method=none` instead.
Defaults to 1.0.
default: '1.0'
availability_policy:
allOf:
- $ref: '#/components/schemas/BillingCreditAvailabilityPolicy'
description: |-
Controls when credits become available for consumption.
Defaults to `on_creation`.
default: on_creation
additionalProperties: false
description: Purchase and payment terms of the grant.
CreateCreditGrantRequest:
type: object
required:
- name
- funding_method
- currency
- amount
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
funding_method:
allOf:
- $ref: '#/components/schemas/BillingCreditFundingMethod'
description: Funding method of the grant.
currency:
allOf:
- $ref: '#/components/schemas/CreateCurrencyCode'
description: The currency of the granted credits.
amount:
allOf:
- $ref: '#/components/schemas/Numeric'
description: Granted credit amount.
purchase:
allOf:
- $ref: '#/components/schemas/CreateCreditGrantPurchase'
description: Present when a funding workflow applies (funding_method is not `none`).
tax_config:
allOf:
- $ref: '#/components/schemas/CreateCreditGrantTaxConfig'
description: |-
Tax configuration for the grant.
For `invoice` and `external` funding methods, tax configuration should be
provided to ensure correct revenue recognition. When not provided, the default
credit grant tax code is applied, if that's not set the global default taxcode
is used.
filters:
$ref: '#/components/schemas/CreateCreditGrantFilters'
priority:
type: integer
format: int16
minimum: 1
maximum: 1000
description: Draw-down priority of the grant. Lower values have higher priority.
default: 10
effective_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
The timestamp when the credit grant becomes effective.
Defaults to the current date and time.
expires_after:
allOf:
- $ref: '#/components/schemas/ISO8601Duration'
description: |-
The duration after which the credit grant expires.
Defaults to never expiring.
key:
allOf:
- $ref: '#/components/schemas/ExternalResourceKey'
description: |-
Idempotency key for the credit grant creation request.
When provided, reusing the same key returns an HTTP 409 Conflict instead of
creating a duplicate grant, which makes create requests safe to retry.
additionalProperties: false
description: CreditGrant create request.
CreateCreditGrantTaxConfig:
type: object
properties:
behavior:
allOf:
- $ref: '#/components/schemas/BillingTaxBehavior'
description: Tax behavior applied to the invoice line item.
tax_code:
allOf:
- $ref: '#/components/schemas/CreateResourceReference'
description: Tax code applied to the invoice line item.
additionalProperties: false
description: |-
Tax configuration for a credit grant.
Tax configuration should be provided to ensure correct revenue recognition,
including for externally funded grants.
title: Tax configuration for a credit grant
CreateCurrencyCode:
type: string
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: Fiat or custom currency code.
x-go-type: string
CreateCurrencyCustomRequest:
type: object
required:
- name
- code
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
The name of the currency. It should be a human-readable string that represents
the name of the currency, such as "US Dollar" or "Euro".
symbol:
type: string
minLength: 1
description: |-
The symbol of the currency. It should be a string that represents the symbol of
the currency, such as "$" for US Dollar or "€" for Euro.
code:
$ref: '#/components/schemas/BillingCurrencyCodeCustom'
additionalProperties: false
description: CurrencyCustom create request.
CreateCustomerRequest:
type: object
required:
- name
- key
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
key:
$ref: '#/components/schemas/ExternalResourceKey'
usage_attribution:
allOf:
- $ref: '#/components/schemas/BillingCustomerUsageAttribution'
description: Mapping to attribute metered usage to the customer by the event subject.
title: Usage Attribution
primary_email:
type: string
description: The primary email address of the customer.
title: Primary Email
currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: Currency of the customer. Used for billing, tax and invoicing.
title: Currency
billing_address:
allOf:
- $ref: '#/components/schemas/Address'
description: The billing address of the customer. Used for tax and invoicing.
title: Billing Address
additionalProperties: false
description: Customer create request.
CreateFeatureRequest:
type: object
required:
- name
- key
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
key:
$ref: '#/components/schemas/ResourceKey'
meter:
allOf:
- $ref: '#/components/schemas/FeatureMeterReference'
description: |-
The meter that the feature is associated with and based on which usage is
calculated. If not specified, the feature is static.
title: Meter reference
unit_cost:
allOf:
- $ref: '#/components/schemas/BillingFeatureUnitCost'
description: |-
Optional per-unit cost configuration. Use "manual" for a fixed per-unit cost, or
"llm" to look up cost from the LLM cost database based on meter group-by
properties.
title: Unit cost
additionalProperties: false
description: Feature create request.
CreateMeterRequest:
type: object
required:
- name
- key
- aggregation
- event_type
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
key:
$ref: '#/components/schemas/ResourceKey'
aggregation:
allOf:
- $ref: '#/components/schemas/MeterAggregation'
description: The aggregation type to use for the meter.
event_type:
type: string
minLength: 1
description: The event type to include in the aggregation.
example: prompt
events_from:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
The date since the meter should include events. Useful to skip old events. If
not specified, all historical events are included.
value_property:
type: string
minLength: 1
description: |-
JSONPath expression to extract the value from the ingested event's data
property.
The ingested value for sum, avg, min, and max aggregations is a number or a
string that can be parsed to a number.
For unique_count aggregation, the ingested value must be a string. For count
aggregation the value_property is ignored.
example: $.tokens
dimensions:
type: object
additionalProperties:
type: string
description: |-
Named JSONPath expressions to extract the group by values from the event data.
Keys must be unique and consist only alphanumeric and underscore characters.
example:
type: $.type
additionalProperties: false
description: Meter create request.
CreatePlanAddonRequest:
type: object
required:
- name
- addon
- from_plan_phase
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
addon:
allOf:
- $ref: '#/components/schemas/AddonReference'
description: The add-on associated with the plan.
title: Add-on
from_plan_phase:
allOf:
- $ref: '#/components/schemas/ResourceKey'
description: The key of the plan phase from which the add-on becomes available for purchase.
title: From plan phase
max_quantity:
type: integer
minimum: 1
description: |-
The maximum number of times the add-on can be purchased for the plan. For
single-instance add-ons this field must be omitted. For multi-instance add-ons
when omitted, unlimited quantity can be purchased.
title: Max quantity
additionalProperties: false
description: PlanAddon create request.
CreatePlanRequest:
type: object
required:
- name
- key
- currency
- billing_cadence
- phases
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
key:
allOf:
- $ref: '#/components/schemas/ResourceKey'
description: |-
A key is a semi-unique string that is used to identify the plan. It is used to
reference the latest `active` version of the plan and is unique with the version
number.
title: Key
currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: The currency code of the plan.
title: Currency
billing_cadence:
allOf:
- $ref: '#/components/schemas/ISO8601Duration'
description: The billing cadence for subscriptions using this plan.
title: Billing cadence
pro_rating_enabled:
type: boolean
description: Whether pro-rating is enabled for this plan.
title: Pro-rating enabled
default: true
phases:
type: array
items:
$ref: '#/components/schemas/BillingPlanPhase'
minItems: 1
description: |-
The plan phases define the pricing ramp for a subscription. A phase switch
occurs only at the end of a billing period. At least one phase is required.
title: Plan phases
additionalProperties: false
description: Plan create request.
CreateResourceReference:
type: object
required:
- id
properties:
id:
$ref: '#/components/schemas/ULID'
additionalProperties: false
description: TaxCode reference.
CreateSubscriptionAddonRequest:
type: object
required:
- addon
- quantity
- timing
properties:
labels:
$ref: '#/components/schemas/Labels'
addon:
allOf:
- $ref: '#/components/schemas/AddonReference'
description: The add-on associated with the subscription.
title: Add-on
quantity:
type: integer
minimum: 1
description: The quantity of the add-on. Always 1 for single instance add-ons.
title: Quantity
timing:
allOf:
- $ref: '#/components/schemas/BillingSubscriptionEditTiming'
description: |-
The timing of the operation. After the create or update, a new entry will be
created in the timeline.
title: Timing
additionalProperties: false
description: SubscriptionAddon create request.
CreateTaxCodeRequest:
type: object
required:
- name
- key
- app_mappings
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
key:
$ref: '#/components/schemas/ResourceKey'
app_mappings:
type: array
items:
$ref: '#/components/schemas/BillingTaxCodeAppMapping'
description: Mapping of app types to tax codes.
title: App type to tax code mappings
additionalProperties: false
description: TaxCode create request.
CreditBalance:
type: object
required:
- currency
- live
- settled
- pending
properties:
currency:
allOf:
- $ref: '#/components/schemas/BillingCurrencyCode'
readOnly: true
live:
allOf:
- $ref: '#/components/schemas/Numeric'
description: Credits available after applying currently live charge impacts.
example: '200.00'
readOnly: true
settled:
allOf:
- $ref: '#/components/schemas/Numeric'
description: Credits that have been booked on the ledger as of the balance timestamp.
example: '150.00'
readOnly: true
pending:
allOf:
- $ref: '#/components/schemas/Numeric'
description: |-
Credits that have been granted but are not yet written to the ledger, or are
written to the ledger with a future booked time.
example: '50.00'
readOnly: true
additionalProperties: false
description: The credit balance by currency.
title: Credit balance
CreditGrantPagePaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/BillingCreditGrant'
meta:
$ref: '#/components/schemas/PaginatedMeta'
additionalProperties: false
description: Page paginated response.
CreditTransactionPaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/BillingCreditTransaction'
meta:
$ref: '#/components/schemas/CursorMeta'
additionalProperties: false
description: Cursor paginated response.
CurrencyAmount:
type: object
required:
- amount
- currency
properties:
amount:
$ref: '#/components/schemas/Numeric'
currency:
$ref: '#/components/schemas/CurrencyCode'
additionalProperties: false
description: Monetary amount in a specific currency.
CurrencyCode:
type: string
minLength: 3
maxLength: 3
pattern: ^[A-Z]{3}$
description: |-
Three-letter [ISO4217](https://www.iso.org/iso-4217-currency-codes.html)
currency code. Custom three-letter currency codes are also supported for
convenience.
example: USD
CurrencyPagePaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/BillingCurrency'
meta:
$ref: '#/components/schemas/PaginatedMeta'
additionalProperties: false
description: Page paginated response.
CursorPaginationQueryPage:
type: object
properties:
size:
type: integer
description: The number of items to include per page.
after:
type: string
description: Request the next page of data, starting with the item after this parameter.
before:
type: string
description: Request the previous page of data, starting with the item before this parameter.
additionalProperties: false
description: Determines which page of the collection to retrieve.
CustomerPagePaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/BillingCustomer'
meta:
$ref: '#/components/schemas/PaginatedMeta'
additionalProperties: false
description: Page paginated response.
CustomerReference:
type: object
required:
- id
properties:
id:
$ref: '#/components/schemas/ULID'
additionalProperties: false
description: Customer reference.
DateTime:
type: string
format: date-time
description: |-
[RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in
UTC.
title: RFC3339 Date-Time
example: '2023-01-01T01:01:01.001Z'
DateTimeFieldFilter:
anyOf:
- $ref: '#/components/schemas/DateTime'
- type: object
properties:
eq:
allOf:
- $ref: '#/components/schemas/DateTime'
description: Value strictly equals given RFC-3339 formatted timestamp in UTC.
lt:
allOf:
- $ref: '#/components/schemas/DateTime'
description: Value is less than the given RFC-3339 formatted timestamp in UTC.
lte:
allOf:
- $ref: '#/components/schemas/DateTime'
description: Value is less than or equal to the given RFC-3339 formatted timestamp in UTC.
gt:
allOf:
- $ref: '#/components/schemas/DateTime'
description: Value is greater than the given RFC-3339 formatted timestamp in UTC.
gte:
allOf:
- $ref: '#/components/schemas/DateTime'
description: Value is greater than or equal to the given RFC-3339 formatted timestamp in UTC.
additionalProperties: false
description: |-
Filters on the given datetime (RFC-3339) field value. All properties are
optional; provide exactly one to specify the comparison.
title: DateTime Field Filter
x-go-type-import:
path: github.com/openmeterio/openmeter/api/v3/filters
x-go-type: filters.FilterDateTime
ExternalResourceKey:
type: string
minLength: 1
maxLength: 256
description: |-
ExternalResourceKey is a unique string that is used to identify a resource in an
external system.
title: External Resource Key
example: 019ae40f-4258-7f15-9491-842f42a7d6ac
Feature:
type: object
required:
- id
- name
- created_at
- updated_at
- key
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
key:
$ref: '#/components/schemas/ResourceKey'
meter:
allOf:
- $ref: '#/components/schemas/FeatureMeterReference'
description: |-
The meter that the feature is associated with and based on which usage is
calculated. If not specified, the feature is static.
title: Meter reference
unit_cost:
allOf:
- $ref: '#/components/schemas/BillingFeatureUnitCost'
description: |-
Optional per-unit cost configuration. Use "manual" for a fixed per-unit cost, or
"llm" to look up cost from the LLM cost database based on meter group-by
properties.
title: Unit cost
additionalProperties: false
description: A capability or billable dimension offered by a provider.
FeatureCostQueryResult:
type: object
required:
- data
properties:
from:
allOf:
- $ref: '#/components/schemas/DateTime'
description: Start of the queried period.
to:
allOf:
- $ref: '#/components/schemas/DateTime'
description: End of the queried period.
data:
type: array
items:
$ref: '#/components/schemas/FeatureCostQueryRow'
description: The cost data rows.
additionalProperties: false
description: Result of a feature cost query.
FeatureCostQueryRow:
type: object
required:
- usage
- cost
- currency
- from
- to
- dimensions
properties:
usage:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The metered usage value for the period.
cost:
type: string
allOf:
- $ref: '#/components/schemas/Numeric'
nullable: true
description: |-
The computed cost amount (usage × unit cost). Null when pricing is not available
for the given combination of dimensions.
currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: The currency code of the cost amount.
detail:
type: string
description: |-
Detail message when cost amount is null, explaining why the cost could not be
resolved.
from:
allOf:
- $ref: '#/components/schemas/DateTime'
description: The start of the time bucket the value is aggregated over.
to:
allOf:
- $ref: '#/components/schemas/DateTime'
description: The end of the time bucket the value is aggregated over.
dimensions:
type: object
additionalProperties:
type: string
description: |-
The dimensions the value is aggregated over. `subject` and `customer_id` are
reserved dimensions.
additionalProperties: false
description: A row in the result of a feature cost query.
FeatureMeterReference:
type: object
required:
- id
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
description: The ID of the meter to associate with this feature.
title: Meter ID
filters:
type: object
additionalProperties:
$ref: '#/components/schemas/QueryFilterStringMapItem'
maxProperties: 10
description: Filters to apply to the dimensions of the meter.
title: Meter dimensions filters
additionalProperties: false
description: Reference to a meter associated with a feature.
FeaturePagePaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/Feature'
meta:
$ref: '#/components/schemas/PaginatedMeta'
additionalProperties: false
description: Page paginated response.
FeatureReference:
type: object
required:
- id
properties:
id:
$ref: '#/components/schemas/ULID'
additionalProperties: false
description: Feature reference.
GetCreditBalanceParamsFilter:
type: object
properties:
currency:
allOf:
- $ref: '#/components/schemas/StringFieldFilterExact'
description: Filter credit balance by currency.
feature_key:
allOf:
- $ref: '#/components/schemas/StringFieldFilter'
description: |-
Filter credit balance by feature key. Omit to return the total portfolio value.
Use `exists=false` to return only unrestricted balance.
additionalProperties: false
description: Filter options for getting a credit balance.
GovernanceFeatureAccess:
type: object
required:
- has_access
properties:
has_access:
type: boolean
description: |-
Whether the customer currently has access to the feature.
`true` for boolean and static entitlements that are available, and for metered
entitlements with remaining balance. `false` when the feature is unavailable,
the usage limit has been reached, or (when applicable) credits have been
exhausted.
title: Has access
readOnly: true
reason:
allOf:
- $ref: '#/components/schemas/GovernanceFeatureAccessReason'
description: |-
Optional reason when the customer does not have access to the feature. Populated
when `has_access` is `false`.
title: Reason
readOnly: true
additionalProperties: false
description: Access status for a single feature.
GovernanceFeatureAccessReason:
type: object
required:
- code
- message
properties:
code:
allOf:
- $ref: '#/components/schemas/GovernanceFeatureAccessReasonCode'
description: Machine-readable error code.
title: Code
readOnly: true
message:
type: string
description: Human-readable description of the error.
title: Message
readOnly: true
attributes:
type: object
additionalProperties: {}
description: Additional structured context.
title: Attributes
readOnly: true
additionalProperties: false
description: Reason a feature is not accessible to a customer.
GovernanceFeatureAccessReasonCode:
type: string
enum:
- unknown
- usage_limit_reached
- feature_unavailable
- feature_not_found
- no_credit_available
description: Machine-readable reason code for denied feature access.
GovernanceQueryError:
type: object
required:
- code
- message
properties:
code:
allOf:
- $ref: '#/components/schemas/GovernanceQueryErrorCode'
description: Machine-readable error code.
title: Code
readOnly: true
message:
type: string
description: Human-readable description of the error.
title: Message
readOnly: true
attributes:
type: object
additionalProperties: {}
description: Additional structured context.
title: Attributes
readOnly: true
customer:
type: string
description: The customer identifier from the request that produced this error.
title: Customer identifier
readOnly: true
additionalProperties: false
description: Query error within a partially successful governance query response.
GovernanceQueryErrorCode:
type: string
enum:
- unknown
- customer_not_found
description: Error code for a governance query failure.
GovernanceQueryRequest:
type: object
required:
- customer
properties:
include_credits:
type: boolean
description: |-
Whether to include credit balance availability for each resolved customer. When
true, each feature evaluation includes credit balance checks.
Defaults to `false`.
title: Include credits
default: false
customer:
allOf:
- $ref: '#/components/schemas/GovernanceQueryRequestCustomers'
title: Customer
feature:
allOf:
- $ref: '#/components/schemas/GovernanceQueryRequestFeatures'
title: Feature
additionalProperties: false
description: Query to evaluate feature access for a list of customers.
GovernanceQueryRequestCustomers:
type: object
required:
- keys
properties:
keys:
type: array
items:
type: string
minItems: 1
maxItems: 100
description: |-
Each entry can be a customer `key` or a usage-attribution subject `key`.
Identifiers that cannot be resolved to a customer are reported in the response
`errors` array.
title: Customer keys and usage-attribution subjects
additionalProperties: false
description: List of customer identifiers to evaluate access for.
GovernanceQueryRequestFeatures:
type: object
required:
- keys
properties:
keys:
type: array
items:
type: string
minItems: 1
maxItems: 100
description: List of feature keys to evaluate access for.
title: Feature Keys
additionalProperties: false
description: |-
Optional list of feature keys to evaluate access for. If omitted, all features
available in the organization are returned. Providing this list is recommended
to reduce the response size and the load on the backend services.
GovernanceQueryResponse:
type: object
required:
- data
- errors
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/GovernanceQueryResult'
description: Access evaluation results, one entry per resolved customer.
title: Data
readOnly: true
errors:
type: array
items:
$ref: '#/components/schemas/GovernanceQueryError'
description: Partial errors encountered while processing the request.
title: Errors
readOnly: true
meta:
allOf:
- $ref: '#/components/schemas/CursorMeta'
description: |-
Pagination metadata. The endpoint may return a partial response if the full
response would exceed server-side limits.
title: Meta
readOnly: true
additionalProperties: false
description: Response of the governance query.
GovernanceQueryResult:
type: object
required:
- matched
- customer
- features
- updated_at
properties:
matched:
type: array
items:
type: string
description: |-
The list of identifiers from the request that resolved to this customer. Each
entry is either the customer `key` or one of its usage-attribution subject
`key`s.
Duplicate or aliased identifiers that resolve to the same customer collapse to a
single result entry, with every requested identifier listed here.
title: Matched identifiers
readOnly: true
customer:
allOf:
- $ref: '#/components/schemas/BillingCustomer'
description: The customer the matched identifiers resolved to.
title: Customer
readOnly: true
features:
type: object
additionalProperties:
$ref: '#/components/schemas/GovernanceFeatureAccess'
description: |-
Map of features with their access status.
Map keys are the feature keys requested in `feature.keys`, or every feature
`key` available in the organization when the feature filter was omitted.
title: Features
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
Timestamp of the most recent change to the customer's access state reflected in
this result.
title: Updated at
readOnly: true
additionalProperties: false
description: Access evaluation result for a single resolved customer.
ISO8601Duration:
type: string
pattern: ^P(?:\d+(?:\.\d+)?Y)?(?:\d+(?:\.\d+)?M)?(?:\d+(?:\.\d+)?W)?(?:\d+(?:\.\d+)?D)?(?:T(?:\d+(?:\.\d+)?H)?(?:\d+(?:\.\d+)?M)?(?:\d+(?:\.\d+)?S)?)?$
description: |-
[ISO 8601 Duration](https://docs.digi.com/resources/documentation/digidocs/90001488-13/reference/r_iso_8601_duration_format.htm)
string.
title: ISO 8601 Duration
example: P1Y
format: ISO8601
IngestedEventPaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/MeteringIngestedEvent'
meta:
$ref: '#/components/schemas/CursorMeta'
additionalProperties: false
description: Cursor paginated response.
InvoicePagePaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/BillingInvoice'
meta:
$ref: '#/components/schemas/PaginatedMeta'
additionalProperties: false
description: Page paginated response.
LLMCostModel:
type: object
required:
- id
- name
properties:
id:
type: string
description: Identifier of the model, e.g., "gpt-4", "claude-3-5-sonnet".
name:
type: string
description: Name of the model, e.g., "GPT-4", "Claude 3.5 Sonnet".
additionalProperties: false
description: LLM Model
LLMCostModelPricing:
type: object
required:
- input_per_token
- output_per_token
properties:
input_per_token:
allOf:
- $ref: '#/components/schemas/Numeric'
description: Input price per token (USD).
output_per_token:
allOf:
- $ref: '#/components/schemas/Numeric'
description: Output price per token (USD).
cache_read_per_token:
allOf:
- $ref: '#/components/schemas/Numeric'
description: Cache read price per token (USD).
cache_write_per_token:
allOf:
- $ref: '#/components/schemas/Numeric'
description: Cache write price per token (USD).
reasoning_per_token:
allOf:
- $ref: '#/components/schemas/Numeric'
description: Reasoning output price per token (USD).
additionalProperties: false
description: Token pricing for an LLM model, denominated per token.
LLMCostOverrideCreate:
type: object
required:
- provider
- model_id
- pricing
- currency
- effective_from
properties:
provider:
type: string
description: Provider/vendor of the model.
model_id:
type: string
description: Canonical model identifier.
model_name:
type: string
description: Human-readable model name.
pricing:
allOf:
- $ref: '#/components/schemas/LLMCostModelPricing'
description: Token pricing data.
currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: Currency code.
effective_from:
allOf:
- $ref: '#/components/schemas/DateTime'
description: When this override becomes effective.
effective_to:
allOf:
- $ref: '#/components/schemas/DateTime'
description: When this override expires.
additionalProperties: false
description: |-
Input for creating a per-namespace price override. Unique per provider, model
and currency. If an override already exists for the given provider, model and
currency, it will be updated. If an override does not exist, it will be created.
LLMCostPrice:
type: object
required:
- id
- provider
- model
- pricing
- currency
- source
- effective_from
- created_at
- updated_at
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
description: Unique identifier.
readOnly: true
provider:
allOf:
- $ref: '#/components/schemas/LLMCostProvider'
description: Provider of the model.
readOnly: true
model:
allOf:
- $ref: '#/components/schemas/LLMCostModel'
description: The model.
readOnly: true
pricing:
allOf:
- $ref: '#/components/schemas/LLMCostModelPricing'
description: Token pricing data.
readOnly: true
currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: Currency code (currently always "USD").
readOnly: true
source:
allOf:
- $ref: '#/components/schemas/LLMCostPriceSource'
description: Where this price came from.
readOnly: true
effective_from:
allOf:
- $ref: '#/components/schemas/DateTime'
description: When this price becomes effective.
readOnly: true
effective_to:
allOf:
- $ref: '#/components/schemas/DateTime'
description: When this price expires. Omitted when the price is currently effective.
readOnly: true
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: Creation timestamp.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: Last update timestamp.
readOnly: true
additionalProperties: false
description: |-
An LLM cost price record, representing the cost per token for a specific model
from a specific provider.
LLMCostPriceSource:
type: string
enum:
- manual
- system
description: Identifies where an LLM cost price came from.
LLMCostProvider:
type: object
required:
- id
- name
properties:
id:
type: string
description: Identifier of the provider, e.g., "openai", "anthropic".
name:
type: string
description: Name of the provider, e.g., "OpenAI", "Anthropic".
additionalProperties: false
description: LLM Provider
ListAddonsParamsFilter:
type: object
properties:
id:
$ref: '#/components/schemas/ULIDFieldFilter'
key:
$ref: '#/components/schemas/StringFieldFilter'
name:
$ref: '#/components/schemas/StringFieldFilter'
status:
$ref: '#/components/schemas/StringFieldFilterExact'
currency:
$ref: '#/components/schemas/StringFieldFilterExact'
additionalProperties: false
description: Filter options for listing add-ons.
ListChargesParamsFilter:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/StringFieldFilterExact'
description: |-
Filter charges by status.
Supported statuses are:
- `created`
- `active`
- `final`
- `deleted`
If omitted, all statuses are returned except for `deleted`.
additionalProperties: false
description: Filter options for listing charges.
ListCostBasesParamsFilter:
type: object
properties:
fiat_code:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: Filter cost bases by fiat currency code.
additionalProperties: false
description: Filter options for listing cost bases.
ListCreditGrantsParamsFilter:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/BillingCreditGrantStatus'
description: Filter credit grants by status.
currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: Filter credit grants by currency.
key:
allOf:
- $ref: '#/components/schemas/StringFieldFilter'
description: Filter credit grants by key.
additionalProperties: false
description: Filter options for listing credit grants.
ListCreditTransactionsParamsFilter:
type: object
properties:
type:
allOf:
- $ref: '#/components/schemas/BillingCreditTransactionType'
description: Filter credit transactions by type.
currency:
allOf:
- $ref: '#/components/schemas/BillingCurrencyCode'
description: Filter credit transactions by currency.
feature_key:
allOf:
- $ref: '#/components/schemas/StringFieldFilter'
description: |-
Filter credit transactions by feature key. Omit to return all credit
transactions. Use `exists=false` to return only unrestricted credit
transactions.
additionalProperties: false
description: Filter options for listing credit transactions.
ListCurrenciesParamsFilter:
type: object
properties:
type:
$ref: '#/components/schemas/BillingCurrencyType'
code:
$ref: '#/components/schemas/StringFieldFilter'
additionalProperties: false
description: Filter options for listing currencies.
ListCustomerEntitlementAccessResponseData:
type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/BillingEntitlementAccessResult'
description: The list of entitlement access results.
readOnly: true
additionalProperties: false
description: List customer entitlement access response data.
ListCustomersParamsFilter:
type: object
properties:
key:
$ref: '#/components/schemas/StringFieldFilter'
name:
$ref: '#/components/schemas/StringFieldFilter'
primary_email:
$ref: '#/components/schemas/StringFieldFilter'
usage_attribution_subject_key:
$ref: '#/components/schemas/StringFieldFilter'
plan_key:
$ref: '#/components/schemas/StringFieldFilter'
billing_profile_id:
$ref: '#/components/schemas/ULIDFieldFilter'
additionalProperties: false
description: Filter options for listing customers.
ListEventsParamsFilter:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/StringFieldFilter'
description: Filter events by ID.
source:
allOf:
- $ref: '#/components/schemas/StringFieldFilter'
description: Filter events by source.
subject:
allOf:
- $ref: '#/components/schemas/StringFieldFilter'
description: Filter events by subject.
type:
allOf:
- $ref: '#/components/schemas/StringFieldFilter'
description: Filter events by type.
customer_id:
allOf:
- $ref: '#/components/schemas/ULIDFieldFilter'
description: Filter events by the associated customer ID.
time:
allOf:
- $ref: '#/components/schemas/DateTimeFieldFilter'
description: Filter events by event time.
ingested_at:
allOf:
- $ref: '#/components/schemas/DateTimeFieldFilter'
description: Filter events by the time the event was ingested.
stored_at:
allOf:
- $ref: '#/components/schemas/DateTimeFieldFilter'
description: Filter events by the time the event was stored.
additionalProperties: false
description: Filter options for listing ingested events.
ListFeatureParamsFilter:
type: object
properties:
meter_id:
$ref: '#/components/schemas/ULIDFieldFilter'
key:
$ref: '#/components/schemas/StringFieldFilter'
name:
$ref: '#/components/schemas/StringFieldFilter'
additionalProperties: false
description: Filter options for listing features.
ListInvoicesParamsFilter:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/StringFieldFilterExact'
description: Filter by invoice status.
customer_id:
allOf:
- $ref: '#/components/schemas/ULIDFieldFilter'
description: Filter by customer ID.
issued_at:
allOf:
- $ref: '#/components/schemas/DateTimeFieldFilter'
description: Filter by the time the invoice was issued.
service_period_start:
allOf:
- $ref: '#/components/schemas/DateTimeFieldFilter'
description: Filter by service period start.
created_at:
allOf:
- $ref: '#/components/schemas/DateTimeFieldFilter'
description: Filter by invoice creation time.
additionalProperties: false
description: Filter options for listing invoices.
ListLLMCostPricesParamsFilter:
type: object
properties:
provider:
allOf:
- $ref: '#/components/schemas/StringFieldFilter'
description: Filter by provider. e.g. ?filter[provider][eq]=openai
model_id:
allOf:
- $ref: '#/components/schemas/StringFieldFilter'
description: Filter by model ID. e.g. ?filter[model_id][eq]=gpt-4
model_name:
allOf:
- $ref: '#/components/schemas/StringFieldFilter'
description: Filter by model name. e.g. ?filter[model_name][contains]=gpt
currency:
allOf:
- $ref: '#/components/schemas/StringFieldFilter'
description: Filter by currency code. e.g. ?filter[currency][eq]=USD
source:
allOf:
- $ref: '#/components/schemas/StringFieldFilter'
description: Filter by source. e.g. ?filter[source][eq]=system
additionalProperties: false
description: Filter options for listing LLM cost prices.
ListMetersParamsFilter:
type: object
properties:
key:
allOf:
- $ref: '#/components/schemas/StringFieldFilter'
description: Filter meters by key.
name:
allOf:
- $ref: '#/components/schemas/StringFieldFilter'
description: Filter meters by name.
additionalProperties: false
description: Filter options for listing meters.
ListPlansParamsFilter:
type: object
properties:
key:
$ref: '#/components/schemas/StringFieldFilter'
name:
$ref: '#/components/schemas/StringFieldFilter'
status:
$ref: '#/components/schemas/StringFieldFilterExact'
currency:
$ref: '#/components/schemas/StringFieldFilterExact'
additionalProperties: false
description: Filter options for listing plans.
ListSubscriptionsParamsFilter:
type: object
properties:
id:
$ref: '#/components/schemas/ULIDFieldFilter'
customer_id:
$ref: '#/components/schemas/ULIDFieldFilter'
status:
$ref: '#/components/schemas/StringFieldFilterExact'
plan_id:
$ref: '#/components/schemas/ULIDFieldFilter'
plan_key:
$ref: '#/components/schemas/StringFieldFilterExact'
additionalProperties: false
description: Filter options for listing subscriptions.
Meter:
type: object
required:
- id
- name
- created_at
- updated_at
- key
- aggregation
- event_type
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
key:
$ref: '#/components/schemas/ResourceKey'
aggregation:
allOf:
- $ref: '#/components/schemas/MeterAggregation'
description: The aggregation type to use for the meter.
event_type:
type: string
minLength: 1
description: The event type to include in the aggregation.
example: prompt
events_from:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
The date since the meter should include events. Useful to skip old events. If
not specified, all historical events are included.
value_property:
type: string
minLength: 1
description: |-
JSONPath expression to extract the value from the ingested event's data
property.
The ingested value for sum, avg, min, and max aggregations is a number or a
string that can be parsed to a number.
For unique_count aggregation, the ingested value must be a string. For count
aggregation the value_property is ignored.
example: $.tokens
dimensions:
type: object
additionalProperties:
type: string
description: |-
Named JSONPath expressions to extract the group by values from the event data.
Keys must be unique and consist only alphanumeric and underscore characters.
example:
type: $.type
additionalProperties: false
description: A meter is a configuration that defines how to match and aggregate events.
example:
id: 01G65Z755AFWAKHE12NY0CQ9FH
key: tokens_total
name: Tokens Total
description: AI Token Usage
aggregation: sum
event_type: prompt
value_property: $.tokens
dimensions:
model: $.model
type: $.type
created_at: '2024-01-01T01:01:01.001Z'
updated_at: '2024-01-01T01:01:01.001Z'
MeterAggregation:
type: string
enum:
- sum
- count
- unique_count
- avg
- min
- max
- latest
description: The aggregation type to use for the meter.
MeterPagePaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/Meter'
meta:
$ref: '#/components/schemas/PaginatedMeta'
additionalProperties: false
description: Page paginated response.
MeterQueryFilters:
type: object
properties:
dimensions:
type: object
additionalProperties:
$ref: '#/components/schemas/QueryFilterStringMapItem'
maxProperties: 10
description: |-
Filters to apply to the dimensions of the query. For `subject` and `customer_id`
only equals ("eq", "in") comparisons are supported.
additionalProperties: false
description: Filters to apply to a meter query.
MeterQueryGranularity:
type: string
enum:
- PT1M
- PT1H
- P1D
- P1M
description: |-
The granularity of the time grouping. Time durations are specified in ISO 8601
format.
MeterQueryRequest:
type: object
properties:
from:
allOf:
- $ref: '#/components/schemas/DateTime'
description: The start of the period the usage is queried from.
to:
allOf:
- $ref: '#/components/schemas/DateTime'
description: The end of the period the usage is queried to.
granularity:
allOf:
- $ref: '#/components/schemas/MeterQueryGranularity'
description: |-
The size of the time buckets to group the usage into. If not specified, the
usage is aggregated over the entire period.
time_zone:
type: string
description: |-
The value is the name of the time zone as defined in the IANA Time Zone Database
(http://www.iana.org/time-zones). The time zone is used to determine the start
and end of the time buckets. If not specified, the UTC timezone will be used.
default: UTC
group_by_dimensions:
type: array
items:
type: string
maxItems: 100
description: The dimensions to group the results by.
example:
- model
- type
filters:
allOf:
- $ref: '#/components/schemas/MeterQueryFilters'
description: Filters to apply to the query.
additionalProperties: false
description: A meter query request.
example:
from: '2023-01-01T00:00:00Z'
to: '2023-01-02T00:00:00Z'
granularity: P1D
time_zone: UTC
MeterQueryResult:
type: object
required:
- data
properties:
from:
allOf:
- $ref: '#/components/schemas/DateTime'
description: The start of the period the usage is queried from.
to:
allOf:
- $ref: '#/components/schemas/DateTime'
description: The end of the period the usage is queried to.
data:
type: array
items:
$ref: '#/components/schemas/MeterQueryRow'
description: The usage data. If no data is available, an empty array is returned.
additionalProperties: false
description: Meter query result.
example:
from: '2023-01-01T00:00:00Z'
to: '2023-01-02T00:00:00Z'
data:
- value: '12.3456'
from: '2023-01-01T00:00:00Z'
to: '2023-01-02T00:00:00Z'
dimensions:
customer_id: 01G65Z755AFWAKHE12NY0CQ9FH
model: gpt-4-turbo
type: input
MeterQueryRow:
type: object
required:
- value
- from
- to
- dimensions
properties:
value:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The aggregated value.
from:
allOf:
- $ref: '#/components/schemas/DateTime'
description: The start of the time bucket the value is aggregated over.
to:
allOf:
- $ref: '#/components/schemas/DateTime'
description: The end of the time bucket the value is aggregated over.
dimensions:
type: object
additionalProperties:
type: string
description: |-
The dimensions the value is aggregated over. `subject` and `customer_id` are
reserved dimensions.
additionalProperties: false
description: A row in the result of a meter query.
example:
value: '12.3456'
from: '2023-01-01T00:00:00Z'
to: '2023-01-02T00:00:00Z'
dimensions:
customer_id: 01G65Z755AFWAKHE12NY0CQ9FH
model: gpt-4-turbo
type: input
MeteringEvent:
type: object
required:
- id
- source
- specversion
- type
- subject
properties:
id:
type: string
minLength: 1
description: Identifies the event.
example: 5c10fade-1c9e-4d6c-8275-c52c36731d3c
source:
type: string
minLength: 1
format: uri-reference
description: Identifies the context in which an event happened.
example: service-name
specversion:
type: string
minLength: 1
description: The version of the CloudEvents specification which the event uses.
example: '1.0'
default: '1.0'
type:
type: string
minLength: 1
description: |-
Contains a value describing the type of event related to the originating
occurrence.
example: com.example.someevent
datacontenttype:
type: string
enum:
- application/json
nullable: true
description: |-
Content type of the CloudEvents data value. Only the value "application/json" is
allowed over HTTP.
example: application/json
dataschema:
type: string
format: uri
nullable: true
minLength: 1
description: Identifies the schema that data adheres to.
subject:
type: string
minLength: 1
description: |-
Describes the subject of the event in the context of the event producer
(identified by source).
example: customer-id
time:
type: string
allOf:
- $ref: '#/components/schemas/DateTime'
nullable: true
description: Timestamp of when the occurrence happened. Must adhere to RFC 3339.
example: '2023-01-01T01:01:01.001Z'
data:
type: object
additionalProperties: {}
nullable: true
description: The event payload. Optional, if present it must be a JSON object.
additionalProperties: false
description: Metering event following the CloudEvents specification.
title: Metering Event
example:
specversion: '1.0'
id: 5c10fade-1c9e-4d6c-8275-c52c36731d3c
source: service-name
type: prompt
subject: customer-id
time: '2023-01-01T01:01:01.001Z'
data:
prompt: Hello, world!
tokens: 100
model: gpt-4o
type: input
MeteringIngestedEvent:
type: object
required:
- event
- ingested_at
- stored_at
properties:
event:
allOf:
- $ref: '#/components/schemas/MeteringEvent'
description: The original event ingested.
customer:
allOf:
- $ref: '#/components/schemas/CustomerReference'
description: The customer if the event is associated with a customer.
ingested_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: The date and time the event was ingested and its processing started.
stored_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: The date and time the event was stored in the database.
validation_errors:
type: array
items:
$ref: '#/components/schemas/MeteringIngestedEventValidationError'
description: The validation errors of the ingested event.
additionalProperties: false
description: An ingested metering event with ingestion metadata.
title: Ingested Event
example:
event:
id: 5c10fade-1c9e-4d6c-8275-c52c36731d3c
source: service-name
specversion: '1.0'
type: prompt
subject: customer_key
time: '2023-01-01T01:01:01.001Z'
customer:
id: 01G65Z755AFWAKHE12NY0CQ9FH
ingested_at: '2023-01-01T01:01:01.001Z'
stored_at: '2023-01-01T01:01:02.001Z'
MeteringIngestedEventValidationError:
type: object
required:
- code
- message
properties:
code:
type: string
description: The machine readable code of the error.
title: Code
readOnly: true
message:
type: string
description: The human readable description of the error.
title: Message
readOnly: true
attributes:
type: object
additionalProperties: {}
description: Additional attributes.
title: Attributes
readOnly: true
additionalProperties: false
description: Event validation errors.
Numeric:
type: string
pattern: ^\-?[0-9]+(\.[0-9]+)?$
description: Numeric represents an arbitrary precision number.
OrganizationDefaultTaxCodes:
type: object
required:
- invoicing_tax_code
- credit_grant_tax_code
- created_at
- updated_at
properties:
invoicing_tax_code:
allOf:
- $ref: '#/components/schemas/TaxCodeReference'
description: Default tax code for invoicing.
title: Invoicing tax code
credit_grant_tax_code:
allOf:
- $ref: '#/components/schemas/TaxCodeReference'
description: Default tax code for credit grants.
title: Credit grant tax code
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: Timestamp of creation.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: Timestamp of last update.
readOnly: true
additionalProperties: false
description: |-
Organization-level default tax code references.
Stores the default tax codes applied to specific billing contexts for this
organization. Provisioned automatically when the organization is created.
PlanAddon:
type: object
required:
- id
- name
- created_at
- updated_at
- addon
- from_plan_phase
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
addon:
allOf:
- $ref: '#/components/schemas/AddonReference'
description: The add-on associated with the plan.
title: Add-on
from_plan_phase:
allOf:
- $ref: '#/components/schemas/ResourceKey'
description: The key of the plan phase from which the add-on becomes available for purchase.
title: From plan phase
max_quantity:
type: integer
minimum: 1
description: |-
The maximum number of times the add-on can be purchased for the plan. For
single-instance add-ons this field must be omitted. For multi-instance add-ons
when omitted, unlimited quantity can be purchased.
title: Max quantity
validation_errors:
type: array
items:
$ref: '#/components/schemas/ProductCatalogValidationError'
description: List of validation errors.
title: Validation errors
readOnly: true
additionalProperties: false
description: |-
PlanAddon represents an association between a plan and an add-on, controlling
which add-ons are available for purchase within a plan.
PlanAddonPagePaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/PlanAddon'
meta:
$ref: '#/components/schemas/PaginatedMeta'
additionalProperties: false
description: Page paginated response.
PlanPagePaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/BillingPlan'
meta:
$ref: '#/components/schemas/PaginatedMeta'
additionalProperties: false
description: Page paginated response.
PricePagePaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/LLMCostPrice'
meta:
$ref: '#/components/schemas/PaginatedMeta'
additionalProperties: false
description: Page paginated response.
ProductCatalogValidationError:
type: object
required:
- code
- message
- field
properties:
code:
type: string
description: Machine-readable error code.
title: Code
readOnly: true
message:
type: string
description: Human-readable description of the error.
title: Message
readOnly: true
attributes:
type: object
additionalProperties: {}
description: Additional structured context.
title: Attributes
readOnly: true
field:
type: string
description: The path to the field.
title: Field
example: addons/pro/ratecards/token/featureKey
readOnly: true
additionalProperties: false
description: Validation errors providing detailed description of the issue.
QueryFilterString:
type: object
properties:
eq:
type: string
description: The attribute equals the provided value.
neq:
type: string
description: The attribute does not equal the provided value.
in:
type: array
items:
type: string
minItems: 1
maxItems: 100
description: The attribute is one of the provided values.
nin:
type: array
items:
type: string
minItems: 1
maxItems: 100
description: The attribute is not one of the provided values.
contains:
type: string
description: The attribute contains the provided value.
ncontains:
type: string
description: The attribute does not contain the provided value.
and:
minItems: 1
maxItems: 10
description: Combines the provided filters with a logical AND.
type: array
items:
$ref: '#/components/schemas/QueryFilterString'
or:
minItems: 1
maxItems: 10
description: Combines the provided filters with a logical OR.
type: array
items:
$ref: '#/components/schemas/QueryFilterString'
additionalProperties: false
description: |-
A query filter for a string attribute. Operators are mutually exclusive, only
one operator is allowed at a time.
title: Query String Filter
QueryFilterStringMapItem:
type: object
properties:
exists:
type: boolean
description: The attribute exists.
eq:
type: string
description: The attribute equals the provided value.
neq:
type: string
description: The attribute does not equal the provided value.
in:
type: array
items:
type: string
minItems: 1
maxItems: 100
description: The attribute is one of the provided values.
nin:
type: array
items:
type: string
minItems: 1
maxItems: 100
description: The attribute is not one of the provided values.
contains:
type: string
description: The attribute contains the provided value.
ncontains:
type: string
description: The attribute does not contain the provided value.
and:
type: array
items:
$ref: '#/components/schemas/QueryFilterString'
minItems: 1
maxItems: 10
description: Combines the provided filters with a logical AND.
or:
type: array
items:
$ref: '#/components/schemas/QueryFilterString'
minItems: 1
maxItems: 10
description: Combines the provided filters with a logical OR.
additionalProperties: false
description: |-
A query filter for an item in a string map attribute. Operators are mutually
exclusive, only one operator is allowed at a time.
title: Query String Map Item Filter
RecurringPeriod:
type: object
required:
- anchor
- interval
properties:
anchor:
allOf:
- $ref: '#/components/schemas/DateTime'
description: A date-time anchor to base the recurring period on.
title: Anchor time
example: '2023-01-01T01:01:01.001Z'
interval:
allOf:
- $ref: '#/components/schemas/ISO8601Duration'
description: The interval duration in ISO 8601 format.
title: Interval in ISO 8601 duration format
example: P1M
additionalProperties: false
description: Recurring period with an anchor and an interval.
ResourceKey:
type: string
minLength: 1
maxLength: 64
pattern: ^[a-z0-9]+(?:_[a-z0-9]+)*$
description: A key is a unique string that is used to identify a resource.
title: Resource Key
example: resource_key
StringFieldFilter:
anyOf:
- type: string
- type: object
properties:
eq:
type: string
description: Value strictly equals the given string value.
neq:
type: string
description: Value does not equal the given string value.
contains:
type: string
description: Value contains the given string value (fuzzy match).
ocontains:
type: string
description: |-
Returns entities that fuzzy-match any of the comma-delimited phrases in the
filter string.
oeq:
type: string
description: |-
Returns entities that exact match any of the comma-delimited phrases in the
filter string.
gt:
type: string
description: Value is greater than the given string value (lexicographic compare).
gte:
type: string
description: |-
Value is greater than or equal to the given string value (lexicographic
compare).
lt:
type: string
description: Value is less than the given string value (lexicographic compare).
lte:
type: string
description: Value is less than or equal to the given string value (lexicographic compare).
exists:
type: boolean
description: |-
When true, the field must be present (non-null); when false, the field must be
absent (null).
additionalProperties: false
description: |-
Filters on the given string field value by either exact or fuzzy match. All
properties are optional; provide exactly one to specify the comparison.
x-go-type-import:
path: github.com/openmeterio/openmeter/api/v3/filters
x-go-type: filters.FilterString
StringFieldFilterExact:
anyOf:
- type: string
- type: object
properties:
eq:
type: string
description: Value strictly equals the given string value.
oeq:
type: string
description: |-
Returns entities that exact match any of the comma-delimited phrases in the
filter string.
neq:
type: string
description: Value does not equal the given string value.
additionalProperties: false
description: |-
Filters on the given string field value by exact match. All properties are
optional; provide exactly one to specify the comparison.
title: String Field Filter Exact
x-go-type-import:
path: github.com/openmeterio/openmeter/api/v3/filters
x-go-type: filters.FilterStringExact
SubscriptionAddon:
type: object
required:
- id
- created_at
- updated_at
- name
- addon
- quantity
- quantity_at
- active_from
- timeline
- rate_cards
properties:
id:
allOf:
- $ref: '#/components/schemas/ULID'
readOnly: true
labels:
$ref: '#/components/schemas/Labels'
created_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity creation date.
readOnly: true
updated_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity last update date.
readOnly: true
deleted_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of entity deletion date.
readOnly: true
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
readOnly: true
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
readOnly: true
addon:
allOf:
- $ref: '#/components/schemas/AddonReference'
description: The add-on associated with the subscription.
title: Add-on
quantity:
type: integer
minimum: 1
description: The quantity of the add-on. Always 1 for single instance add-ons.
title: Quantity
quantity_at:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
An ISO-8601 timestamp representation of which point in time the quantity was
resolved to.
readOnly: true
active_from:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of the cadence start of the resource.
readOnly: true
active_to:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of the cadence end of the resource.
readOnly: true
timeline:
type: array
items:
$ref: '#/components/schemas/SubscriptionAddonTimelineSegment'
description: The timeline of the add-on. The returned periods are sorted and continuous.
title: Timeline
example:
- quantity: 1
active_from: '2025-01-01T00:00:00Z'
active_to: '2025-01-02T00:00:00Z'
- quantity: 0
active_from: '2025-01-02T00:00:00Z'
active_to: '2025-01-03T00:00:00Z'
- quantity: 1
active_from: '2025-01-03T00:00:00Z'
readOnly: true
rate_cards:
type: array
items:
$ref: '#/components/schemas/SubscriptionAddonRateCard'
description: The rate cards of the add-on.
title: Rate cards
readOnly: true
additionalProperties: false
description: Addon purchased with a subscription.
SubscriptionAddonPagePaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/SubscriptionAddon'
meta:
$ref: '#/components/schemas/PaginatedMeta'
additionalProperties: false
description: Page paginated response.
SubscriptionAddonRateCard:
type: object
required:
- rate_card
- affected_subscription_item_ids
properties:
rate_card:
allOf:
- $ref: '#/components/schemas/BillingRateCard'
description: The rate card.
title: Rate card
affected_subscription_item_ids:
type: array
items:
$ref: '#/components/schemas/ULID'
description: The IDs of the subscription items that this rate card belongs to.
title: Affected subscription item IDs
readOnly: true
additionalProperties: false
description: A rate card for a subscription add-on.
SubscriptionAddonTimelineSegment:
type: object
required:
- active_from
- quantity
properties:
active_from:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of the cadence start of the resource.
readOnly: true
active_to:
allOf:
- $ref: '#/components/schemas/DateTime'
description: An ISO-8601 timestamp representation of the cadence end of the resource.
readOnly: true
quantity:
type: integer
minimum: 0
description: The quantity of the add-on for the given period.
title: Quantity
example: 1
readOnly: true
additionalProperties: false
description: A subscription add-on event.
SubscriptionPagePaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/BillingSubscription'
meta:
$ref: '#/components/schemas/PaginatedMeta'
additionalProperties: false
description: Page paginated response.
TaxCodePagePaginatedResponse:
type: object
required:
- data
- meta
properties:
data:
type: array
items:
$ref: '#/components/schemas/BillingTaxCode'
meta:
$ref: '#/components/schemas/PaginatedMeta'
additionalProperties: false
description: Page paginated response.
TaxCodeReference:
type: object
required:
- id
properties:
id:
$ref: '#/components/schemas/ULID'
additionalProperties: false
description: TaxCode reference.
ULID:
type: string
pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
description: ULID (Universally Unique Lexicographically Sortable Identifier).
title: ULID
example: 01G65Z755AFWAKHE12NY0CQ9FH
ULIDFieldFilter:
anyOf:
- $ref: '#/components/schemas/ULID'
- type: object
properties:
eq:
allOf:
- $ref: '#/components/schemas/ULID'
description: Value strictly equals the given ULID value.
oeq:
type: string
description: |-
Returns entities that exact match any of the comma-delimited ULIDs in the filter
string.
neq:
allOf:
- $ref: '#/components/schemas/ULID'
description: Value does not equal the given ULID value.
additionalProperties: false
description: |-
Filters on the given ULID field value by exact match. All properties are
optional; provide exactly one to specify the comparison.
title: ULID Field Filter
x-go-type-import:
path: github.com/openmeterio/openmeter/api/v3/filters
x-go-type: filters.FilterULID
UpdateAddress:
type: object
properties:
country:
allOf:
- $ref: '#/components/schemas/CountryCode'
description: |-
Country code in [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html)
alpha-2 format.
title: Country
postal_code:
type: string
description: Postal code.
title: Postal Code
state:
type: string
description: State or province.
title: State
city:
type: string
description: City.
title: City
line1:
type: string
description: First line of the address.
title: Line 1
line2:
type: string
description: Second line of the address.
title: Line 2
phone_number:
type: string
description: Phone number.
title: Phone Number
additionalProperties: false
description: Address
UpdateBillingInvoiceWorkflow:
type: object
properties:
invoicing:
allOf:
- $ref: '#/components/schemas/UpdateBillingInvoiceWorkflowInvoicingSettings'
description: Invoicing settings for this invoice.
title: Invoicing settings
payment:
allOf:
- $ref: '#/components/schemas/UpdateBillingWorkflowPaymentSettings'
description: Payment settings for this invoice.
title: Payment settings
additionalProperties: false
description: |-
Invoice-level snapshot of the workflow configuration.
Contains only the settings that are meaningful for an already-created invoice:
invoicing behaviour and payment settings. Collection alignment and tax policy
are gather-time / profile-wide concerns and are not included.
UpdateBillingInvoiceWorkflowInvoicingSettings:
type: object
properties:
auto_advance:
type: boolean
description: Whether to automatically issue the invoice after the draft_period has passed.
default: true
draft_period:
type: string
format: ISO8601
description: The period for the invoice to be kept in draft status for manual reviews.
example: P1D
default: P0D
additionalProperties: false
description: |-
Invoice-level invoicing settings.
A subset of BillingWorkflowInvoicingSettings limited to fields that are
meaningful per-invoice. progressive_billing is omitted as it is a gather-time /
profile-level decision.
UpdateBillingPartyAddresses:
type: object
required:
- billing_address
properties:
billing_address:
allOf:
- $ref: '#/components/schemas/UpdateAddress'
description: Billing address.
additionalProperties: false
description: A collection of addresses for the party.
UpdateBillingPartyTaxIdentity:
type: object
properties:
code:
allOf:
- $ref: '#/components/schemas/BillingTaxIdentificationCode'
description: Normalized tax identification code shown on the original identity document.
additionalProperties: false
description: |-
Identity stores the details required to identify an entity for tax purposes in a
specific country.
UpdateBillingWorkflowPaymentChargeAutomaticallySettings:
type: object
required:
- collection_method
properties:
collection_method:
type: string
enum:
- charge_automatically
description: The collection method for the invoice.
additionalProperties: false
description: |-
Payment settings for a billing workflow when the collection method is charge
automatically.
UpdateBillingWorkflowPaymentSendInvoiceSettings:
type: object
required:
- collection_method
properties:
collection_method:
type: string
enum:
- send_invoice
description: The collection method for the invoice.
due_after:
type: string
format: ISO8601
description: |-
The period after which the invoice is due. With some payment solutions it's only
applicable for manual collection method.
example: P30D
default: P30D
additionalProperties: false
description: |-
Payment settings for a billing workflow when the collection method is send
invoice.
UpdateBillingWorkflowPaymentSettings:
type: object
oneOf:
- $ref: '#/components/schemas/UpdateBillingWorkflowPaymentChargeAutomaticallySettings'
- $ref: '#/components/schemas/UpdateBillingWorkflowPaymentSendInvoiceSettings'
discriminator:
propertyName: collection_method
mapping:
charge_automatically: '#/components/schemas/UpdateBillingWorkflowPaymentChargeAutomaticallySettings'
send_invoice: '#/components/schemas/UpdateBillingWorkflowPaymentSendInvoiceSettings'
description: Payment settings for a billing workflow.
UpdateClosedPeriod:
type: object
required:
- from
- to
properties:
from:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
The start of the period.
The period is inclusive at the start.
title: Start
example: '2023-01-01T01:01:01.001Z'
to:
allOf:
- $ref: '#/components/schemas/DateTime'
description: |-
The end of the period.
The period is exclusive at the end.
title: End
example: '2023-01-01T01:01:01.001Z'
additionalProperties: false
description: |-
A period with defined start and end dates.
The period is always inclusive at the start and exclusive at the end.
UpdateCreditGrantExternalSettlementRequest:
type: object
required:
- status
properties:
status:
allOf:
- $ref: '#/components/schemas/BillingCreditPurchasePaymentSettlementStatus'
description: The new payment settlement status.
additionalProperties: false
description: |-
Request body for updating the external payment settlement status of a credit
grant.
UpdateCustomerUsageAttribution:
type: object
required:
- subject_keys
properties:
subject_keys:
type: array
items:
$ref: '#/components/schemas/UsageAttributionSubjectKey'
minItems: 0
description: |-
The subjects that are attributed to the customer. Can be empty when no usage
event subjects are associated with the customer.
title: Subject Keys
additionalProperties: false
description: |-
Mapping to attribute metered usage to the customer. One customer can have zero
or more subjects, but one subject can only belong to one customer.
UpdateDiscounts:
type: object
properties:
percentage:
type: number
minimum: 0
maximum: 100
description: Percentage discount applied to the price (0–100).
usage:
allOf:
- $ref: '#/components/schemas/Numeric'
description: |-
Number of usage units granted free before billing starts. Only applies to
usage-based lines (not flat fees). Usage is treated as zero until this amount is
exhausted.
additionalProperties: false
description: Discount configuration for a rate card.
UpdateFeatureRequest:
type: object
properties:
unit_cost:
allOf:
- $ref: '#/components/schemas/BillingFeatureUnitCost'
nullable: true
description: |-
Optional per-unit cost configuration. Use "manual" for a fixed per-unit cost, or
"llm" to look up cost from the LLM cost database based on meter group-by
properties. Set to `null` to clear the existing unit cost; omit to leave it
unchanged.
title: Unit cost
additionalProperties: false
description: |-
Request body for updating a feature. Currently only the unit_cost field can be
updated.
UpdateInvoiceCustomer:
type: object
required:
- name
- id
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
usage_attribution:
allOf:
- $ref: '#/components/schemas/UpdateCustomerUsageAttribution'
description: Mapping to attribute metered usage to the customer by the event subject.
title: Usage Attribution
billing_address:
allOf:
- $ref: '#/components/schemas/UpdateAddress'
description: The billing address of the customer. Used for tax and invoicing.
title: Billing Address
id:
$ref: '#/components/schemas/ULID'
key:
allOf:
- $ref: '#/components/schemas/ExternalResourceKey'
description: |-
Optional external resource key for the customer.
Omitted when the customer was created without a key. Unlike on the customer
resource itself, the key is optional here because the invoice snapshot may
predate or omit it.
additionalProperties: false
description: Snapshot of the customer's information at the time the invoice was issued.
UpdateInvoiceLine:
type: object
oneOf:
- $ref: '#/components/schemas/UpdateInvoiceStandardLine'
discriminator:
propertyName: type
mapping:
standard_line: '#/components/schemas/UpdateInvoiceStandardLine'
description: |-
A top-level line item on an invoice.
Each line represents a single charge, typically associated with a rate card from
a subscription. Detailed (child) lines are nested under `detailed_lines` when
present.
UpdateInvoiceLineRateCard:
type: object
required:
- price
properties:
price:
allOf:
- $ref: '#/components/schemas/UpdatePrice'
description: The price definition used to calculate charges for this line.
title: Price
tax_config:
allOf:
- $ref: '#/components/schemas/UpdateRateCardTaxConfig'
description: Tax configuration snapshot for this line.
title: Tax config
feature_key:
allOf:
- $ref: '#/components/schemas/ResourceKey'
description: The feature key associated with this line's rate card.
title: Feature key
discounts:
allOf:
- $ref: '#/components/schemas/UpdateDiscounts'
description: Discount configuration from the rate card.
title: Discounts
additionalProperties: false
description: Rate card configuration snapshot for a usage-based invoice line.
UpdateInvoiceRequest:
type: object
oneOf:
- $ref: '#/components/schemas/UpdateInvoiceStandardRequest'
discriminator:
propertyName: type
mapping:
standard: '#/components/schemas/UpdateInvoiceStandardRequest'
description: UpdateInvoiceRequest update request.
UpdateInvoiceStandardLine:
type: object
required:
- name
- type
- service_period
- rate_card
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
id:
allOf:
- $ref: '#/components/schemas/ULID'
description: |-
ID of the line.
Optional on update: omit to create a new line, or supply the ID of an existing
line to edit it. Existing lines omitted from an update's `lines` array are
deleted.
title: ID
type:
type: string
enum:
- standard_line
description: The type of charge this line item represents.
title: Type
service_period:
allOf:
- $ref: '#/components/schemas/UpdateClosedPeriod'
description: |-
The service period covered by this invoice, spanning the earliest line start to
the latest line end across all of its lines.
For an invoice with no lines the period is empty, which means `from` will be
equal to `to`.
title: Service period
rate_card:
allOf:
- $ref: '#/components/schemas/UpdateInvoiceLineRateCard'
description: The rate card configuration snapshot used to price this line item.
title: Rate card
additionalProperties: false
description: |-
A top-level line item on an invoice.
Each line represents a single charge, typically associated with a rate card from
a subscription. Detailed (child) lines are nested under `detailed_lines` when
present.
UpdateInvoiceStandardRequest:
type: object
required:
- supplier
- customer
- type
- workflow
properties:
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
supplier:
allOf:
- $ref: '#/components/schemas/UpdateSupplier'
description: |-
Snapshot of the supplier's contact information at the time the invoice was
issued.
title: Supplier
customer:
allOf:
- $ref: '#/components/schemas/UpdateInvoiceCustomer'
description: Snapshot of the customer's information at the time the invoice was issued.
title: Customer
type:
type: string
enum:
- standard
description: Discriminator field identifying this as a standard invoice.
title: Type
workflow:
allOf:
- $ref: '#/components/schemas/UpdateInvoiceWorkflowSettings'
description: Workflow configuration snapshot captured at invoice creation time.
title: Workflow
lines:
type: array
items:
$ref: '#/components/schemas/UpdateInvoiceLine'
description: |-
Line items on this invoice.
Always returned on single-resource GET; omitted on list endpoints unless
explicitly expanded. Editable via update: existing lines are matched by `id`,
lines without an `id` are created, and lines present on the invoice but omitted
from the update request are deleted. Detailed (child) lines are always computed
and cannot be edited directly.
title: Lines
additionalProperties: false
description: InvoiceStandard update request.
UpdateInvoiceWorkflowSettings:
type: object
required:
- workflow
properties:
workflow:
allOf:
- $ref: '#/components/schemas/UpdateBillingInvoiceWorkflow'
description: |-
The workflow configuration that was active when the invoice was created.
Only the fields that are meaningful at the per-invoice level are included:
invoicing behaviour (auto-advance, draft period) and payment settings
(collection method, due date). Profile-wide settings such as collection
alignment, progressive billing, and tax policy are omitted.
title: Workflow config
additionalProperties: false
description: Snapshot of the billing workflow configuration captured at invoice creation.
UpdateMeterRequest:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
dimensions:
type: object
additionalProperties:
type: string
description: |-
Named JSONPath expressions to extract the group by values from the event data.
Keys must be unique and consist only alphanumeric and underscore characters.
example:
type: $.type
additionalProperties: false
description: Meter update request.
UpdateOrganizationDefaultTaxCodesRequest:
type: object
properties:
invoicing_tax_code:
allOf:
- $ref: '#/components/schemas/TaxCodeReference'
description: Default tax code for invoicing.
title: Invoicing tax code
credit_grant_tax_code:
allOf:
- $ref: '#/components/schemas/TaxCodeReference'
description: Default tax code for credit grants.
title: Credit grant tax code
additionalProperties: false
description: OrganizationDefaultTaxCodes update request.
UpdatePrice:
type: object
oneOf:
- $ref: '#/components/schemas/UpdatePriceFree'
- $ref: '#/components/schemas/UpdatePriceFlat'
- $ref: '#/components/schemas/UpdatePriceUnit'
- $ref: '#/components/schemas/UpdatePriceGraduated'
- $ref: '#/components/schemas/UpdatePriceVolume'
discriminator:
propertyName: type
mapping:
free: '#/components/schemas/UpdatePriceFree'
flat: '#/components/schemas/UpdatePriceFlat'
unit: '#/components/schemas/UpdatePriceUnit'
graduated: '#/components/schemas/UpdatePriceGraduated'
volume: '#/components/schemas/UpdatePriceVolume'
description: Price.
UpdatePriceFlat:
type: object
required:
- type
- amount
properties:
type:
type: string
enum:
- flat
description: The type of the price.
title: Type
amount:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The amount of the flat price.
title: Amount
additionalProperties: false
description: Flat price.
UpdatePriceFree:
type: object
required:
- type
properties:
type:
type: string
enum:
- free
description: The type of the price.
title: Type
additionalProperties: false
description: Free price.
UpdatePriceGraduated:
type: object
required:
- type
- tiers
properties:
type:
type: string
enum:
- graduated
description: The type of the price.
title: Type
tiers:
type: array
items:
$ref: '#/components/schemas/UpdatePriceTier'
minItems: 1
description: The tiers of the graduated price. At least one tier is required.
title: Tiers
additionalProperties: false
description: |-
Graduated tiered price.
Each tier's rate applies only to the usage within that tier. Pricing can change
as cumulative usage crosses tier boundaries.
When UnitConfig is present on the rate card, tier boundaries (up_to_amount) are
expressed in converted billing units.
UpdatePriceTier:
type: object
properties:
up_to_amount:
allOf:
- $ref: '#/components/schemas/Numeric'
description: |-
Up to and including this quantity will be contained in the tier. If undefined,
the tier is open-ended (the last tier).
title: Up to quantity
flat_price:
allOf:
- $ref: '#/components/schemas/UpdatePriceFlat'
description: The flat price component of the tier. Charged once when the tier is entered.
title: Flat price component
unit_price:
allOf:
- $ref: '#/components/schemas/UpdatePriceUnit'
description: The unit price component of the tier. Charged per billing unit within the tier.
title: Unit price component
additionalProperties: false
description: |-
A price tier used in graduated and volume pricing.
At least one price component (flat_price or unit_price) must be set. When
UnitConfig is present on the rate card, up_to_amount is expressed in converted
billing units.
UpdatePriceUnit:
type: object
required:
- type
- amount
properties:
type:
type: string
enum:
- unit
description: The type of the price.
title: Type
amount:
allOf:
- $ref: '#/components/schemas/Numeric'
description: The amount of the unit price.
title: Amount
additionalProperties: false
description: |-
Unit price.
Charges a fixed rate per billing unit. When UnitConfig is present on the rate
card, billing units are the converted quantities (e.g. GB instead of bytes).
UpdatePriceVolume:
type: object
required:
- type
- tiers
properties:
type:
type: string
enum:
- volume
description: The type of the price.
title: Type
tiers:
type: array
items:
$ref: '#/components/schemas/UpdatePriceTier'
minItems: 1
description: The tiers of the volume price. At least one tier is required.
title: Tiers
additionalProperties: false
description: |-
Volume tiered price.
The maximum quantity within a period determines the per-unit price for all units
in that period.
When UnitConfig is present on the rate card, tier boundaries (up_to_amount) are
expressed in converted billing units.
UpdateRateCardTaxConfig:
type: object
required:
- code
properties:
behavior:
$ref: '#/components/schemas/BillingTaxBehavior'
code:
$ref: '#/components/schemas/UpdateResourceReference'
additionalProperties: false
description: The tax config of the rate card.
UpdateResourceReference:
type: object
required:
- id
properties:
id:
$ref: '#/components/schemas/ULID'
additionalProperties: false
description: TaxCode reference.
UpdateSupplier:
type: object
properties:
name:
type: string
description: Legal name or representation of the party.
tax_id:
allOf:
- $ref: '#/components/schemas/UpdateBillingPartyTaxIdentity'
description: |-
The entity's legal identification used for tax purposes. They may have other
numbers, but we're only interested in those valid for tax purposes.
addresses:
allOf:
- $ref: '#/components/schemas/UpdateBillingPartyAddresses'
description: Address for where information should be sent if needed.
id:
type: string
description: Unique identifier for the party.
additionalProperties: false
description: |-
Snapshot of the supplier's information at the time the invoice was issued.
Structurally a read-only subset of `BillingParty` (the type configured on the
billing profile), so the snapshot stays aligned with the source. `key` is
omitted because it is not part of the snapshotted supplier data.
UpsertAddonRequest:
type: object
required:
- name
- instance_type
- rate_cards
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
instance_type:
allOf:
- $ref: '#/components/schemas/AddonInstanceType'
description: The InstanceType of the add-ons. Can be "single" or "multiple".
title: The InstanceType of the add-ons. Can be "single" or "multiple".
rate_cards:
type: array
items:
$ref: '#/components/schemas/BillingRateCard'
description: The rate cards of the add-on.
title: Rate cards
additionalProperties: false
description: Addon upsert request.
UpsertAppCustomerDataRequest:
type: object
properties:
stripe:
allOf:
- $ref: '#/components/schemas/BillingAppCustomerDataStripe'
description: Used if the customer has a linked Stripe app.
title: Stripe
external_invoicing:
allOf:
- $ref: '#/components/schemas/BillingAppCustomerDataExternalInvoicing'
description: Used if the customer has a linked external invoicing app.
title: External invoicing
additionalProperties: false
description: AppCustomerData upsert request.
UpsertBillingProfileRequest:
type: object
required:
- name
- supplier
- workflow
- default
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
supplier:
allOf:
- $ref: '#/components/schemas/BillingParty'
description: |-
The name and contact information for the supplier this billing profile
represents
workflow:
allOf:
- $ref: '#/components/schemas/BillingWorkflow'
description: The billing workflow settings for this profile
default:
type: boolean
description: Whether this is the default profile.
additionalProperties: false
description: BillingProfile upsert request.
UpsertCustomerBillingDataRequest:
type: object
properties:
billing_profile:
allOf:
- $ref: '#/components/schemas/BillingProfileReference'
description: |-
The billing profile for the customer.
If not provided, the default billing profile will be used.
title: Billing profile
app_data:
allOf:
- $ref: '#/components/schemas/BillingAppCustomerData'
description: App customer data.
title: App customer data
additionalProperties: false
description: CustomerBillingData upsert request.
UpsertCustomerRequest:
type: object
required:
- name
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
usage_attribution:
allOf:
- $ref: '#/components/schemas/BillingCustomerUsageAttribution'
description: Mapping to attribute metered usage to the customer by the event subject.
title: Usage Attribution
primary_email:
type: string
description: The primary email address of the customer.
title: Primary Email
currency:
allOf:
- $ref: '#/components/schemas/CurrencyCode'
description: Currency of the customer. Used for billing, tax and invoicing.
title: Currency
billing_address:
allOf:
- $ref: '#/components/schemas/Address'
description: The billing address of the customer. Used for tax and invoicing.
title: Billing Address
additionalProperties: false
description: Customer upsert request.
UpsertPlanAddonRequest:
type: object
required:
- name
- from_plan_phase
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
from_plan_phase:
allOf:
- $ref: '#/components/schemas/ResourceKey'
description: The key of the plan phase from which the add-on becomes available for purchase.
title: From plan phase
max_quantity:
type: integer
minimum: 1
description: |-
The maximum number of times the add-on can be purchased for the plan. For
single-instance add-ons this field must be omitted. For multi-instance add-ons
when omitted, unlimited quantity can be purchased.
title: Max quantity
additionalProperties: false
description: PlanAddon upsert request.
UpsertPlanRequest:
type: object
required:
- name
- phases
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
pro_rating_enabled:
type: boolean
description: Whether pro-rating is enabled for this plan.
title: Pro-rating enabled
default: true
phases:
type: array
items:
$ref: '#/components/schemas/BillingPlanPhase'
minItems: 1
description: |-
The plan phases define the pricing ramp for a subscription. A phase switch
occurs only at the end of a billing period. At least one phase is required.
title: Plan phases
additionalProperties: false
description: Plan upsert request.
UpsertTaxCodeRequest:
type: object
required:
- name
- app_mappings
properties:
name:
type: string
minLength: 1
maxLength: 256
description: |-
Display name of the resource.
Between 1 and 256 characters.
description:
type: string
maxLength: 1024
description: |-
Optional description of the resource.
Maximum 1024 characters.
labels:
$ref: '#/components/schemas/Labels'
app_mappings:
type: array
items:
$ref: '#/components/schemas/BillingTaxCodeAppMapping'
description: Mapping of app types to tax codes.
title: App type to tax code mappings
additionalProperties: false
description: TaxCode upsert request.
UsageAttributionSubjectKey:
type: string
minLength: 1
description: Subject key.
VoidCreditGrantRequest:
type: object
properties:
payment_adjustment:
allOf:
- $ref: '#/components/schemas/BillingCreditGrantVoidPaymentAdjustment'
description: |-
How voiding adjusts payment state related to the grant.
Currently only `none` is supported: voiding does not adjust invoices, payment
authorization, settlement, payment intents, or external collection state. If
payment later completes, the original invoiced amount may still be collected.
default: none
additionalProperties: false
description: Request body for voiding a credit grant.
SortQuery:
title: SortQuery
type: string
example: created_at desc
description: |
The `asc` suffix is optional as the default sort order is ascending.
The `desc` suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').
Labels:
title: Labels
type: object
example:
env: test
maxProperties: 50
description: |
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".
additionalProperties:
type: string
pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
minLength: 1
maxLength: 63
PageMeta:
type: object
description: Contains pagination query parameters and the total number of objects returned.
required:
- number
- size
- total
properties:
number:
type: number
example: 1
x-speakeasy-terraform-ignore: true
size:
type: number
example: 10
x-speakeasy-terraform-ignore: true
total:
type: number
example: 100
x-speakeasy-terraform-ignore: true
PaginatedMeta:
type: object
title: PaginatedMeta
x-speakeasy-terraform-ignore: true
description: returns the pagination information
properties:
page:
$ref: '#/components/schemas/PageMeta'
required:
- page
BaseError:
type: object
title: Error
description: standard error
required:
- status
- title
- instance
- detail
properties:
status:
type: integer
description: |
The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.
readOnly: true
title:
type: string
description: |
A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as "Sentence case" for direct use in the UI.
readOnly: true
type:
type: string
description: The error type.
readOnly: true
instance:
type: string
description: |
Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.
readOnly: true
detail:
type: string
description: |
A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as "Sentence case" for direct use in the UI.
readOnly: true
InvalidRules:
description: invalid parameters rules
type: string
readOnly: true
nullable: true
enum:
- required
- is_array
- is_base64
- is_boolean
- is_date_time
- is_integer
- is_null
- is_number
- is_object
- is_string
- is_uuid
- is_fqdn
- is_arn
- unknown_property
- missing_reference
- is_label
- matches_regex
- invalid
- is_supported_network_availability_zone_list
- is_supported_network_cidr_block
- is_supported_provider_region
- type
InvalidParameterStandard:
type: object
additionalProperties: false
properties:
field:
type: string
example: name
readOnly: true
rule:
$ref: '#/components/schemas/InvalidRules'
source:
type: string
example: body
reason:
type: string
example: is a required field
readOnly: true
required:
- field
- reason
InvalidParameterMinimumLength:
type: object
additionalProperties: false
properties:
field:
type: string
example: name
readOnly: true
rule:
description: invalid parameters rules
type: string
readOnly: true
nullable: false
enum:
- min_length
- min_digits
- min_lowercase
- min_uppercase
- min_symbols
- min_items
- min
minimum:
type: integer
example: 8
source:
type: string
example: body
reason:
type: string
example: must have at least 8 characters
readOnly: true
required:
- field
- reason
- rule
- minimum
InvalidParameterMaximumLength:
type: object
additionalProperties: false
properties:
field:
type: string
example: name
readOnly: true
rule:
description: invalid parameters rules
type: string
readOnly: true
nullable: false
enum:
- max_length
- max_items
- max
maximum:
type: integer
example: 8
source:
type: string
example: body
reason:
type: string
example: must not have more than 8 characters
readOnly: true
required:
- field
- reason
- rule
- maximum
InvalidParameterChoiceItem:
type: object
additionalProperties: false
properties:
field:
type: string
example: name
readOnly: true
rule:
description: invalid parameters rules
type: string
readOnly: true
nullable: false
enum:
- enum
reason:
type: string
example: is a required field
readOnly: true
choices:
type: array
uniqueItems: true
readOnly: true
nullable: false
minItems: 1
items: {}
source:
type: string
example: body
required:
- field
- reason
- rule
- choices
InvalidParameterDependentItem:
type: object
additionalProperties: false
properties:
field:
type: string
example: name
readOnly: true
rule:
description: invalid parameters rules
type: string
readOnly: true
nullable: true
enum:
- dependent_fields
reason:
type: string
example: is a required field
readOnly: true
dependents:
type: array
uniqueItems: true
nullable: true
items: {}
readOnly: true
source:
type: string
example: body
required:
- field
- rule
- reason
- dependents
InvalidParameters:
type: array
nullable: false
uniqueItems: true
minItems: 1
description: invalid parameters
items:
oneOf:
- $ref: '#/components/schemas/InvalidParameterStandard'
- $ref: '#/components/schemas/InvalidParameterMinimumLength'
- $ref: '#/components/schemas/InvalidParameterMaximumLength'
- $ref: '#/components/schemas/InvalidParameterChoiceItem'
- $ref: '#/components/schemas/InvalidParameterDependentItem'
BadRequestError:
allOf:
- $ref: '#/components/schemas/BaseError'
- type: object
required:
- invalid_parameters
properties:
invalid_parameters:
$ref: '#/components/schemas/InvalidParameters'
UnauthorizedError:
allOf:
- $ref: '#/components/schemas/BaseError'
- type: object
properties:
status:
example: 401
title:
example: Unauthorized
type:
example: https://httpstatuses.com/401
instance:
example: kong:trace:1234567890
detail:
example: Invalid credentials
ForbiddenError:
allOf:
- $ref: '#/components/schemas/BaseError'
- type: object
properties:
status:
example: 403
title:
example: Forbidden
type:
example: https://httpstatuses.com/403
instance:
example: kong:trace:1234567890
detail:
example: Forbidden
NotFoundError:
allOf:
- $ref: '#/components/schemas/BaseError'
- type: object
properties:
status:
example: 404
title:
example: Not Found
type:
example: https://httpstatuses.com/404
instance:
example: kong:trace:1234567890
detail:
example: Not found
GoneError:
allOf:
- $ref: '#/components/schemas/BaseError'
- type: object
properties:
status:
example: 410
title:
example: Gone
type:
example: https://httpstatuses.com/410
instance:
example: kong:trace:1234567890
detail:
example: Gone
ConflictError:
allOf:
- $ref: '#/components/schemas/BaseError'
- type: object
properties:
status:
example: 409
title:
example: Conflict
type:
example: https://httpstatuses.com/409
instance:
example: kong:trace:1234567890
detail:
example: Conflict
CursorMetaPage:
type: object
required:
- size
- next
- previous
properties:
first:
description: URI to the first page
type: string
format: path
last:
description: URI to the last page
type: string
format: path
next:
description: URI to the next page
type: string
format: path
nullable: true
previous:
description: URI to the previous page
type: string
format: path
nullable: true
size:
description: Requested page size
type: number
example: 10
CursorMeta:
type: object
description: Pagination metadata.
required:
- page
properties:
page:
$ref: '#/components/schemas/CursorMetaPage'
responses:
BadRequest:
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/BadRequestError'
Unauthorized:
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
examples:
UnauthorizedExample:
$ref: '#/components/examples/UnauthorizedExample'
Forbidden:
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ForbiddenError'
examples:
UnauthorizedExample:
$ref: '#/components/examples/ForbiddenExample'
NotFound:
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/NotFoundError'
examples:
NotFoundExample:
$ref: '#/components/examples/NotFoundExample'
Gone:
description: Gone
content:
application/problem+json:
schema:
$ref: '#/components/schemas/GoneError'
Conflict:
description: Conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ConflictError'
examples:
UnauthorizedExample:
value:
status: 401
title: Unauthorized
instance: kong:trace:8347343766220159418
detail: Unauthorized
ForbiddenExample:
value:
status: 403
title: Forbidden
instance: kong:trace:2723154947768991354
detail: You do not have permission to perform this action
NotFoundExample:
value:
status: 404
title: Not Found
instance: kong:trace:6816496025408232265
detail: Not Found
|