{ "item": [ { "id": "d45415db-cb59-4ca7-9c4e-00268dde8361", "name": "Chargebacks", "description": { "content": "", "type": "text/markdown" }, "item": [ { "name": "List chargebacks (deprecated) (v3)", "request": { "name": "List chargebacks (deprecated)", "description": { "content": "List all meshChargebacks with optional filtering by workspace, project, and billing period.\n\n**Note**: If no request parameters for filtering are specified, all meshChargebacks are returned independently of\nthese parameters. By default, meshChargebacks are sorted descending by period.\n\n**Info**: The meshTenantUsageReport endpoints are the preferred endpoints to get cost data from meshStack. The\nmeshTenantUsageReport endpoints provide more detailed information and more filter options than the chargeback\nstatements. They contain basically the same information as a chargeback, but only per tenant, not per project.\n\nFor customers who export chargeback statements on a monthly basis, the following recommendation applies:\nchargeback statements of the previous month should be processed no earlier than one day after the configured\nfinalization date, at 7 a.m. (German local time). By default, chargeback statements are finalized at the 6th of a\nmonth, therefore, they can be processed starting at the 7th of a month at 7 a.m. If you are unsure about the\nconfiguration of the finalization day of chargebacks in your meshStack, please contact our support team.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshchargebacks" ], "host": [ "{{endpoint}}" ], "query": [ { "disabled": true, "key": "page", "value": "0", "description": { "content": "Zero-based index of the page to return.", "type": "text/markdown" } }, { "disabled": true, "key": "size", "value": "50", "description": { "content": "Number of elements per page. A larger size is reduced to the maximum.", "type": "text/markdown" } }, { "disabled": true, "key": "sort", "value": "customerIdentifier", "description": { "content": "Sort order as `,asc` or `,desc`, ascending if the direction is left out. Repeat the parameter to sort by several keys. Sortable keys: `workspaceIdentifier`, `projectIdentifier`, `period`, `partnerIdentifier`. Without `sort`, the order is `period,desc`.", "type": "text/markdown" } }, { "disabled": true, "key": "projectIdentifier", "value": "", "description": { "content": "Filter for meshChargebacks that belong to the meshProject with given identifier.", "type": "text/markdown" } }, { "disabled": true, "key": "period", "value": "", "description": { "content": "Filter for meshChargebacks that belong to the provided period, e.g. '2022-01-01Z'.", "type": "text/markdown" } }, { "disabled": true, "key": "finalized", "value": "", "description": { "content": "Filter for finalized or preview meshChargebacks. Provide 'true' to get finalized meshChargebacks or provide\n'false' to get preview meshChargebacks.", "type": "text/markdown" } }, { "disabled": true, "key": "finalizedSince", "value": "", "description": { "content": "Filter for meshChargebacks finalized at or after this timestamp.", "type": "text/markdown" } }, { "disabled": true, "key": "cancelledSince", "value": "", "description": { "content": "Filter for meshChargebacks cancelled at or after this timestamp. Without it, cancelled\nmeshChargebacks are left out.", "type": "text/markdown" } }, { "disabled": true, "key": "workspaceIdentifier", "value": "", "description": { "content": "Filter for meshChargebacks that belong to the meshWorkspace with given identifier.", "type": "text/markdown" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshchargeback.v3.hal+json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The page of chargebacks", "originalRequest": { "name": "List chargebacks (deprecated)", "description": { "content": "List all meshChargebacks with optional filtering by workspace, project, and billing period.\n\n**Note**: If no request parameters for filtering are specified, all meshChargebacks are returned independently of\nthese parameters. By default, meshChargebacks are sorted descending by period.\n\n**Info**: The meshTenantUsageReport endpoints are the preferred endpoints to get cost data from meshStack. The\nmeshTenantUsageReport endpoints provide more detailed information and more filter options than the chargeback\nstatements. They contain basically the same information as a chargeback, but only per tenant, not per project.\n\nFor customers who export chargeback statements on a monthly basis, the following recommendation applies:\nchargeback statements of the previous month should be processed no earlier than one day after the configured\nfinalization date, at 7 a.m. (German local time). By default, chargeback statements are finalized at the 6th of a\nmonth, therefore, they can be processed starting at the 7th of a month at 7 a.m. If you are unsure about the\nconfiguration of the finalization day of chargebacks in your meshStack, please contact our support team.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshchargebacks" ], "host": [ "{{endpoint}}" ], "query": [ { "disabled": true, "key": "page", "value": "0", "description": { "content": "Zero-based index of the page to return.", "type": "text/markdown" } }, { "disabled": true, "key": "size", "value": "50", "description": { "content": "Number of elements per page. A larger size is reduced to the maximum.", "type": "text/markdown" } }, { "disabled": true, "key": "sort", "value": "customerIdentifier", "description": { "content": "Sort order as `,asc` or `,desc`, ascending if the direction is left out. Repeat the parameter to sort by several keys. Sortable keys: `workspaceIdentifier`, `projectIdentifier`, `period`, `partnerIdentifier`. Without `sort`, the order is `period,desc`.", "type": "text/markdown" } }, { "disabled": true, "key": "projectIdentifier", "value": "", "description": { "content": "Filter for meshChargebacks that belong to the meshProject with given identifier.", "type": "text/markdown" } }, { "disabled": true, "key": "period", "value": "", "description": { "content": "Filter for meshChargebacks that belong to the provided period, e.g. '2022-01-01Z'.", "type": "text/markdown" } }, { "disabled": true, "key": "finalized", "value": "", "description": { "content": "Filter for finalized or preview meshChargebacks. Provide 'true' to get finalized meshChargebacks or provide\n'false' to get preview meshChargebacks.", "type": "text/markdown" } }, { "disabled": true, "key": "finalizedSince", "value": "", "description": { "content": "Filter for meshChargebacks finalized at or after this timestamp.", "type": "text/markdown" } }, { "disabled": true, "key": "cancelledSince", "value": "", "description": { "content": "Filter for meshChargebacks cancelled at or after this timestamp. Without it, cancelled\nmeshChargebacks are left out.", "type": "text/markdown" } }, { "disabled": true, "key": "workspaceIdentifier", "value": "", "description": { "content": "Filter for meshChargebacks that belong to the meshWorkspace with given identifier.", "type": "text/markdown" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshchargeback.v3.hal+json" } ], "method": "GET", "auth": null }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.meshcloud.api.meshchargeback.v3.hal+json" } ], "body": "{\n \"_embedded\": {\n \"meshChargebacks\": [\n {\n \"kind\": \"meshChargeback\",\n \"apiVersion\": \"v3\",\n \"metadata\": {\n \"name\": \"2025-01-01Z/my-partner:my-workspace:my-project\",\n \"createdOn\": \"2024-07-29T15:51:28.071Z\",\n \"finalized\": false,\n \"finalizationDate\": \"2024-07-29T15:51:28.071Z\",\n \"cancellationDate\": \"2024-07-29T15:51:28.071Z\",\n \"version\": 0\n },\n \"spec\": {\n \"workspaceIdentifier\": \"my-workspace\",\n \"customerIdentifier\": \"my-workspace\",\n \"projectIdentifier\": \"my-project\",\n \"period\": \"2025-01-01Z\",\n \"tags\": {}\n },\n \"status\": {\n \"timeframe\": {\n \"from\": \"2024-07-29T15:51:28.071Z\",\n \"to\": \"2024-07-29T15:51:28.071Z\"\n },\n \"lineItems\": [\n {\n \"reportCategory\": \"BILLING\",\n \"platformTenantId\": \"b8e2c4a6-1d3f-4e57-9a0b-7c6d5e4f3a21\",\n \"platformFullIdentifier\": \"my-platform.my-location\",\n \"reportId\": \"TenantUsageReports/my-platform.my-location:b8e2c4a6-1d3f-4e57-9a0b-7c6d5e4f3a21:2025-01-01Z\",\n \"entryDate\": \"2024-07-29T15:51:28.071Z\",\n \"period\": \"2025-01-01Z\",\n \"netAmount\": 0,\n \"baseNetAmount\": 0,\n \"baseCurrency\": \"EUR\",\n \"exchangeRate\": 0,\n \"currency\": \"USD\",\n \"sellerId\": \"STACKIT\",\n \"sellerProductGroup\": \"Compute\"\n }\n ],\n \"netAmounts\": [\n {\n \"currency\": \"USD\",\n \"amount\": 0,\n \"baseCurrency\": \"EUR\",\n \"baseNetAmount\": 0\n }\n ]\n },\n \"_links\": {}\n }\n ]\n },\n \"_links\": {},\n \"page\": {\n \"size\": 0,\n \"totalElements\": 0,\n \"totalPages\": 0,\n \"number\": 0\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List chargebacks (deprecated) (v2)", "request": { "name": "List chargebacks (deprecated)", "description": { "content": "List all meshChargebacks with optional filtering by workspace, project, and billing period.\n\n**Note**: If no request parameters for filtering are specified, all meshChargebacks are returned independently of\nthese parameters. By default, meshChargebacks are sorted descending by period.\n\n**Info**: The meshTenantUsageReport endpoints are the preferred endpoints to get cost data from meshStack. The\nmeshTenantUsageReport endpoints provide more detailed information and more filter options than the chargeback\nstatements. They contain basically the same information as a chargeback, but only per tenant, not per project.\n\nFor customers who export chargeback statements on a monthly basis, the following recommendation applies:\nchargeback statements of the previous month should be processed no earlier than one day after the configured\nfinalization date, at 7 a.m. (German local time). By default, chargeback statements are finalized at the 6th of a\nmonth, therefore, they can be processed starting at the 7th of a month at 7 a.m. If you are unsure about the\nconfiguration of the finalization day of chargebacks in your meshStack, please contact our support team.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshchargebacks" ], "host": [ "{{endpoint}}" ], "query": [ { "disabled": true, "key": "page", "value": "0", "description": { "content": "Zero-based index of the page to return.", "type": "text/markdown" } }, { "disabled": true, "key": "size", "value": "50", "description": { "content": "Number of elements per page. A larger size is reduced to the maximum.", "type": "text/markdown" } }, { "disabled": true, "key": "sort", "value": "customerIdentifier", "description": { "content": "Sort order as `,asc` or `,desc`, ascending if the direction is left out. Repeat the parameter to sort by several keys. Sortable keys: `workspaceIdentifier`, `projectIdentifier`, `period`, `partnerIdentifier`. Without `sort`, the order is `period,desc`.", "type": "text/markdown" } }, { "disabled": true, "key": "projectIdentifier", "value": "", "description": { "content": "Filter for meshChargebacks that belong to the meshProject with given identifier.", "type": "text/markdown" } }, { "disabled": true, "key": "period", "value": "", "description": { "content": "Filter for meshChargebacks that belong to the provided period, e.g. '2022-01-01Z'.", "type": "text/markdown" } }, { "disabled": true, "key": "finalized", "value": "", "description": { "content": "Filter for finalized or preview meshChargebacks. Provide 'true' to get finalized meshChargebacks or provide\n'false' to get preview meshChargebacks.", "type": "text/markdown" } }, { "disabled": true, "key": "finalizedSince", "value": "", "description": { "content": "Filter for meshChargebacks finalized at or after this timestamp.", "type": "text/markdown" } }, { "disabled": true, "key": "cancelledSince", "value": "", "description": { "content": "Filter for meshChargebacks cancelled at or after this timestamp. Without it, cancelled\nmeshChargebacks are left out.", "type": "text/markdown" } }, { "disabled": true, "key": "workspaceIdentifier", "value": "", "description": { "content": "Filter for meshChargebacks that belong to the meshWorkspace with given identifier.", "type": "text/markdown" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshchargeback.v2.hal+json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The page of chargebacks", "originalRequest": { "name": "List chargebacks (deprecated)", "description": { "content": "List all meshChargebacks with optional filtering by workspace, project, and billing period.\n\n**Note**: If no request parameters for filtering are specified, all meshChargebacks are returned independently of\nthese parameters. By default, meshChargebacks are sorted descending by period.\n\n**Info**: The meshTenantUsageReport endpoints are the preferred endpoints to get cost data from meshStack. The\nmeshTenantUsageReport endpoints provide more detailed information and more filter options than the chargeback\nstatements. They contain basically the same information as a chargeback, but only per tenant, not per project.\n\nFor customers who export chargeback statements on a monthly basis, the following recommendation applies:\nchargeback statements of the previous month should be processed no earlier than one day after the configured\nfinalization date, at 7 a.m. (German local time). By default, chargeback statements are finalized at the 6th of a\nmonth, therefore, they can be processed starting at the 7th of a month at 7 a.m. If you are unsure about the\nconfiguration of the finalization day of chargebacks in your meshStack, please contact our support team.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshchargebacks" ], "host": [ "{{endpoint}}" ], "query": [ { "disabled": true, "key": "page", "value": "0", "description": { "content": "Zero-based index of the page to return.", "type": "text/markdown" } }, { "disabled": true, "key": "size", "value": "50", "description": { "content": "Number of elements per page. A larger size is reduced to the maximum.", "type": "text/markdown" } }, { "disabled": true, "key": "sort", "value": "customerIdentifier", "description": { "content": "Sort order as `,asc` or `,desc`, ascending if the direction is left out. Repeat the parameter to sort by several keys. Sortable keys: `workspaceIdentifier`, `projectIdentifier`, `period`, `partnerIdentifier`. Without `sort`, the order is `period,desc`.", "type": "text/markdown" } }, { "disabled": true, "key": "projectIdentifier", "value": "", "description": { "content": "Filter for meshChargebacks that belong to the meshProject with given identifier.", "type": "text/markdown" } }, { "disabled": true, "key": "period", "value": "", "description": { "content": "Filter for meshChargebacks that belong to the provided period, e.g. '2022-01-01Z'.", "type": "text/markdown" } }, { "disabled": true, "key": "finalized", "value": "", "description": { "content": "Filter for finalized or preview meshChargebacks. Provide 'true' to get finalized meshChargebacks or provide\n'false' to get preview meshChargebacks.", "type": "text/markdown" } }, { "disabled": true, "key": "finalizedSince", "value": "", "description": { "content": "Filter for meshChargebacks finalized at or after this timestamp.", "type": "text/markdown" } }, { "disabled": true, "key": "cancelledSince", "value": "", "description": { "content": "Filter for meshChargebacks cancelled at or after this timestamp. Without it, cancelled\nmeshChargebacks are left out.", "type": "text/markdown" } }, { "disabled": true, "key": "workspaceIdentifier", "value": "", "description": { "content": "Filter for meshChargebacks that belong to the meshWorkspace with given identifier.", "type": "text/markdown" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshchargeback.v2.hal+json" } ], "method": "GET", "auth": null }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.meshcloud.api.meshchargeback.v2.hal+json" } ], "body": "{\n \"_embedded\": {\n \"meshChargebacks\": [\n {\n \"kind\": \"meshChargeback\",\n \"apiVersion\": \"v3\",\n \"metadata\": {\n \"name\": \"2025-01-01Z/my-partner:my-workspace:my-project\",\n \"createdOn\": \"2024-07-29T15:51:28.071Z\",\n \"finalized\": false,\n \"finalizationDate\": \"2024-07-29T15:51:28.071Z\",\n \"cancellationDate\": \"2024-07-29T15:51:28.071Z\",\n \"version\": 0\n },\n \"spec\": {\n \"workspaceIdentifier\": \"my-workspace\",\n \"customerIdentifier\": \"my-workspace\",\n \"projectIdentifier\": \"my-project\",\n \"period\": \"2025-01-01Z\",\n \"tags\": {}\n },\n \"status\": {\n \"timeframe\": {\n \"from\": \"2024-07-29T15:51:28.071Z\",\n \"to\": \"2024-07-29T15:51:28.071Z\"\n },\n \"lineItems\": [\n {\n \"reportCategory\": \"BILLING\",\n \"platformTenantId\": \"b8e2c4a6-1d3f-4e57-9a0b-7c6d5e4f3a21\",\n \"platformFullIdentifier\": \"my-platform.my-location\",\n \"reportId\": \"TenantUsageReports/my-platform.my-location:b8e2c4a6-1d3f-4e57-9a0b-7c6d5e4f3a21:2025-01-01Z\",\n \"entryDate\": \"2024-07-29T15:51:28.071Z\",\n \"period\": \"2025-01-01Z\",\n \"netAmount\": 0,\n \"baseNetAmount\": 0,\n \"baseCurrency\": \"EUR\",\n \"exchangeRate\": 0,\n \"currency\": \"USD\",\n \"sellerId\": \"STACKIT\",\n \"sellerProductGroup\": \"Compute\"\n }\n ],\n \"netAmounts\": [\n {\n \"currency\": \"USD\",\n \"amount\": 0,\n \"baseCurrency\": \"EUR\",\n \"baseNetAmount\": 0\n }\n ]\n },\n \"_links\": {}\n }\n ]\n },\n \"_links\": {},\n \"page\": {\n \"size\": 0,\n \"totalElements\": 0,\n \"totalPages\": 0,\n \"number\": 0\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List chargebacks (deprecated) (v1)", "request": { "name": "List chargebacks (deprecated)", "description": { "content": "List all meshChargebacks with optional filtering by workspace, project, and billing period.\n\n**Note**: If no request parameters for filtering are specified, all meshChargebacks are returned independently of\nthese parameters. By default, meshChargebacks are sorted descending by period.\n\n**Info**: The meshTenantUsageReport endpoints are the preferred endpoints to get cost data from meshStack. The\nmeshTenantUsageReport endpoints provide more detailed information and more filter options than the chargeback\nstatements. They contain basically the same information as a chargeback, but only per tenant, not per project.\n\nFor customers who export chargeback statements on a monthly basis, the following recommendation applies:\nchargeback statements of the previous month should be processed no earlier than one day after the configured\nfinalization date, at 7 a.m. (German local time). By default, chargeback statements are finalized at the 6th of a\nmonth, therefore, they can be processed starting at the 7th of a month at 7 a.m. If you are unsure about the\nconfiguration of the finalization day of chargebacks in your meshStack, please contact our support team.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshchargebacks" ], "host": [ "{{endpoint}}" ], "query": [ { "disabled": true, "key": "page", "value": "0", "description": { "content": "Zero-based index of the page to return.", "type": "text/markdown" } }, { "disabled": true, "key": "size", "value": "50", "description": { "content": "Number of elements per page. A larger size is reduced to the maximum.", "type": "text/markdown" } }, { "disabled": true, "key": "sort", "value": "customerIdentifier", "description": { "content": "Sort order as `,asc` or `,desc`, ascending if the direction is left out. Repeat the parameter to sort by several keys. Sortable keys: `customerIdentifier`, `projectIdentifier`, `period`, `partnerIdentifier`. Without `sort`, the order is `period,desc`.", "type": "text/markdown" } }, { "disabled": true, "key": "customerIdentifier", "value": "", "description": { "content": "Filter for meshChargebacks that belong to the meshWorkspace with given identifier.", "type": "text/markdown" } }, { "disabled": true, "key": "projectIdentifier", "value": "", "description": { "content": "Filter for meshChargebacks that belong to the meshProject with given identifier.", "type": "text/markdown" } }, { "disabled": true, "key": "period", "value": "", "description": { "content": "Filter for meshChargebacks that belong to the provided period, e.g. '2022-01-01Z'.", "type": "text/markdown" } }, { "disabled": true, "key": "finalized", "value": "", "description": { "content": "Filter for finalized or preview meshChargebacks. Provide 'true' to get finalized meshChargebacks or provide\n'false' to get preview meshChargebacks.", "type": "text/markdown" } }, { "disabled": true, "key": "finalizedSince", "value": "", "description": { "content": "Filter for meshChargebacks finalized at or after this timestamp.", "type": "text/markdown" } }, { "disabled": true, "key": "cancelledSince", "value": "", "description": { "content": "Filter for meshChargebacks cancelled at or after this timestamp. Without it, cancelled\nmeshChargebacks are left out.", "type": "text/markdown" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshchargeback.v1.hal+json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The page of chargebacks", "originalRequest": { "name": "List chargebacks (deprecated)", "description": { "content": "List all meshChargebacks with optional filtering by workspace, project, and billing period.\n\n**Note**: If no request parameters for filtering are specified, all meshChargebacks are returned independently of\nthese parameters. By default, meshChargebacks are sorted descending by period.\n\n**Info**: The meshTenantUsageReport endpoints are the preferred endpoints to get cost data from meshStack. The\nmeshTenantUsageReport endpoints provide more detailed information and more filter options than the chargeback\nstatements. They contain basically the same information as a chargeback, but only per tenant, not per project.\n\nFor customers who export chargeback statements on a monthly basis, the following recommendation applies:\nchargeback statements of the previous month should be processed no earlier than one day after the configured\nfinalization date, at 7 a.m. (German local time). By default, chargeback statements are finalized at the 6th of a\nmonth, therefore, they can be processed starting at the 7th of a month at 7 a.m. If you are unsure about the\nconfiguration of the finalization day of chargebacks in your meshStack, please contact our support team.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshchargebacks" ], "host": [ "{{endpoint}}" ], "query": [ { "disabled": true, "key": "page", "value": "0", "description": { "content": "Zero-based index of the page to return.", "type": "text/markdown" } }, { "disabled": true, "key": "size", "value": "50", "description": { "content": "Number of elements per page. A larger size is reduced to the maximum.", "type": "text/markdown" } }, { "disabled": true, "key": "sort", "value": "customerIdentifier", "description": { "content": "Sort order as `,asc` or `,desc`, ascending if the direction is left out. Repeat the parameter to sort by several keys. Sortable keys: `customerIdentifier`, `projectIdentifier`, `period`, `partnerIdentifier`. Without `sort`, the order is `period,desc`.", "type": "text/markdown" } }, { "disabled": true, "key": "customerIdentifier", "value": "", "description": { "content": "Filter for meshChargebacks that belong to the meshWorkspace with given identifier.", "type": "text/markdown" } }, { "disabled": true, "key": "projectIdentifier", "value": "", "description": { "content": "Filter for meshChargebacks that belong to the meshProject with given identifier.", "type": "text/markdown" } }, { "disabled": true, "key": "period", "value": "", "description": { "content": "Filter for meshChargebacks that belong to the provided period, e.g. '2022-01-01Z'.", "type": "text/markdown" } }, { "disabled": true, "key": "finalized", "value": "", "description": { "content": "Filter for finalized or preview meshChargebacks. Provide 'true' to get finalized meshChargebacks or provide\n'false' to get preview meshChargebacks.", "type": "text/markdown" } }, { "disabled": true, "key": "finalizedSince", "value": "", "description": { "content": "Filter for meshChargebacks finalized at or after this timestamp.", "type": "text/markdown" } }, { "disabled": true, "key": "cancelledSince", "value": "", "description": { "content": "Filter for meshChargebacks cancelled at or after this timestamp. Without it, cancelled\nmeshChargebacks are left out.", "type": "text/markdown" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshchargeback.v1.hal+json" } ], "method": "GET", "auth": null }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.meshcloud.api.meshchargeback.v1.hal+json" } ], "body": "{\n \"_embedded\": {\n \"meshChargebacks\": [\n {\n \"kind\": \"meshChargeback\",\n \"apiVersion\": \"v3\",\n \"metadata\": {\n \"name\": \"2025-01-01Z/my-partner:my-workspace:my-project\",\n \"createdOn\": \"2024-07-29T15:51:28.071Z\",\n \"finalized\": false,\n \"finalizationDate\": \"2024-07-29T15:51:28.071Z\",\n \"cancellationDate\": \"2024-07-29T15:51:28.071Z\",\n \"version\": 0\n },\n \"spec\": {\n \"workspaceIdentifier\": \"my-workspace\",\n \"customerIdentifier\": \"my-workspace\",\n \"projectIdentifier\": \"my-project\",\n \"period\": \"2025-01-01Z\",\n \"tags\": {}\n },\n \"status\": {\n \"timeframe\": {\n \"from\": \"2024-07-29T15:51:28.071Z\",\n \"to\": \"2024-07-29T15:51:28.071Z\"\n },\n \"lineItems\": [\n {\n \"reportCategory\": \"BILLING\",\n \"platformTenantId\": \"b8e2c4a6-1d3f-4e57-9a0b-7c6d5e4f3a21\",\n \"platformFullIdentifier\": \"my-platform.my-location\",\n \"reportId\": \"TenantUsageReports/my-platform.my-location:b8e2c4a6-1d3f-4e57-9a0b-7c6d5e4f3a21:2025-01-01Z\",\n \"entryDate\": \"2024-07-29T15:51:28.071Z\",\n \"period\": \"2025-01-01Z\",\n \"netAmount\": 0,\n \"baseNetAmount\": 0,\n \"baseCurrency\": \"EUR\",\n \"exchangeRate\": 0,\n \"currency\": \"USD\",\n \"sellerId\": \"STACKIT\",\n \"sellerProductGroup\": \"Compute\"\n }\n ],\n \"netAmounts\": [\n {\n \"currency\": \"USD\",\n \"amount\": 0,\n \"baseCurrency\": \"EUR\",\n \"baseNetAmount\": 0\n }\n ]\n },\n \"_links\": {}\n }\n ]\n },\n \"_links\": {},\n \"page\": {\n \"size\": 0,\n \"totalElements\": 0,\n \"totalPages\": 0,\n \"number\": 0\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get chargeback by period and scope (deprecated) (v3)", "request": { "name": "Get chargeback by period and scope (deprecated)", "description": { "content": "Retrieve detailed information about a specific meshChargeback including line items and cost breakdown.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshchargebacks", ":chargebackPeriod", ":chargebackScope" ], "host": [ "{{endpoint}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{chargebackPeriod}}", "key": "chargebackPeriod", "description": { "content": "(Required) The period of the chargeback in YYYY-MM-DDZ format (e.g. '2025-02-01Z').", "type": "text/markdown" } }, { "disabled": false, "type": "any", "value": "{{chargebackScope}}", "key": "chargebackScope", "description": { "content": "(Required) The 'scope' consisting of partner identifier, workspace identifier and project identifier separated by ':' (e.g.\n'testPartner:testWorkspace:testProject').", "type": "text/markdown" } } ] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshchargeback.v3.hal+json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The chargeback", "originalRequest": { "name": "Get chargeback by period and scope (deprecated)", "description": { "content": "Retrieve detailed information about a specific meshChargeback including line items and cost breakdown.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshchargebacks", ":chargebackPeriod", ":chargebackScope" ], "host": [ "{{endpoint}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{chargebackPeriod}}", "key": "chargebackPeriod", "description": { "content": "(Required) The period of the chargeback in YYYY-MM-DDZ format (e.g. '2025-02-01Z').", "type": "text/markdown" } }, { "disabled": false, "type": "any", "value": "{{chargebackScope}}", "key": "chargebackScope", "description": { "content": "(Required) The 'scope' consisting of partner identifier, workspace identifier and project identifier separated by ':' (e.g.\n'testPartner:testWorkspace:testProject').", "type": "text/markdown" } } ] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshchargeback.v3.hal+json" } ], "method": "GET", "auth": null }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.meshcloud.api.meshchargeback.v3.hal+json" } ], "body": "{\n \"kind\": \"meshChargeback\",\n \"apiVersion\": \"v3\",\n \"metadata\": {\n \"name\": \"2025-01-01Z/my-partner:my-workspace:my-project\",\n \"createdOn\": \"2024-07-29T15:51:28.071Z\",\n \"finalized\": false,\n \"finalizationDate\": \"2024-07-29T15:51:28.071Z\",\n \"cancellationDate\": \"2024-07-29T15:51:28.071Z\",\n \"version\": 0\n },\n \"spec\": {\n \"workspaceIdentifier\": \"my-workspace\",\n \"customerIdentifier\": \"my-workspace\",\n \"projectIdentifier\": \"my-project\",\n \"period\": \"2025-01-01Z\",\n \"tags\": {}\n },\n \"status\": {\n \"timeframe\": {\n \"from\": \"2024-07-29T15:51:28.071Z\",\n \"to\": \"2024-07-29T15:51:28.071Z\"\n },\n \"lineItems\": [\n {\n \"reportCategory\": \"BILLING\",\n \"platformTenantId\": \"b8e2c4a6-1d3f-4e57-9a0b-7c6d5e4f3a21\",\n \"platformFullIdentifier\": \"my-platform.my-location\",\n \"reportId\": \"TenantUsageReports/my-platform.my-location:b8e2c4a6-1d3f-4e57-9a0b-7c6d5e4f3a21:2025-01-01Z\",\n \"entryDate\": \"2024-07-29T15:51:28.071Z\",\n \"period\": \"2025-01-01Z\",\n \"netAmount\": 0,\n \"baseNetAmount\": 0,\n \"baseCurrency\": \"EUR\",\n \"exchangeRate\": 0,\n \"currency\": \"USD\",\n \"sellerId\": \"STACKIT\",\n \"sellerProductGroup\": \"Compute\"\n }\n ],\n \"netAmounts\": [\n {\n \"currency\": \"USD\",\n \"amount\": 0,\n \"baseCurrency\": \"EUR\",\n \"baseNetAmount\": 0\n }\n ]\n },\n \"_links\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get chargeback by period and scope (deprecated) (v2)", "request": { "name": "Get chargeback by period and scope (deprecated)", "description": { "content": "Retrieve detailed information about a specific meshChargeback including line items and cost breakdown.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshchargebacks", ":chargebackPeriod", ":chargebackScope" ], "host": [ "{{endpoint}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{chargebackPeriod}}", "key": "chargebackPeriod", "description": { "content": "(Required) The period of the chargeback in YYYY-MM-DDZ format (e.g. '2025-02-01Z').", "type": "text/markdown" } }, { "disabled": false, "type": "any", "value": "{{chargebackScope}}", "key": "chargebackScope", "description": { "content": "(Required) The 'scope' consisting of partner identifier, workspace identifier and project identifier separated by ':' (e.g.\n'testPartner:testWorkspace:testProject').", "type": "text/markdown" } } ] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshchargeback.v2.hal+json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The chargeback", "originalRequest": { "name": "Get chargeback by period and scope (deprecated)", "description": { "content": "Retrieve detailed information about a specific meshChargeback including line items and cost breakdown.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshchargebacks", ":chargebackPeriod", ":chargebackScope" ], "host": [ "{{endpoint}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{chargebackPeriod}}", "key": "chargebackPeriod", "description": { "content": "(Required) The period of the chargeback in YYYY-MM-DDZ format (e.g. '2025-02-01Z').", "type": "text/markdown" } }, { "disabled": false, "type": "any", "value": "{{chargebackScope}}", "key": "chargebackScope", "description": { "content": "(Required) The 'scope' consisting of partner identifier, workspace identifier and project identifier separated by ':' (e.g.\n'testPartner:testWorkspace:testProject').", "type": "text/markdown" } } ] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshchargeback.v2.hal+json" } ], "method": "GET", "auth": null }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.meshcloud.api.meshchargeback.v2.hal+json" } ], "body": "{\n \"kind\": \"meshChargeback\",\n \"apiVersion\": \"v3\",\n \"metadata\": {\n \"name\": \"2025-01-01Z/my-partner:my-workspace:my-project\",\n \"createdOn\": \"2024-07-29T15:51:28.071Z\",\n \"finalized\": false,\n \"finalizationDate\": \"2024-07-29T15:51:28.071Z\",\n \"cancellationDate\": \"2024-07-29T15:51:28.071Z\",\n \"version\": 0\n },\n \"spec\": {\n \"workspaceIdentifier\": \"my-workspace\",\n \"customerIdentifier\": \"my-workspace\",\n \"projectIdentifier\": \"my-project\",\n \"period\": \"2025-01-01Z\",\n \"tags\": {}\n },\n \"status\": {\n \"timeframe\": {\n \"from\": \"2024-07-29T15:51:28.071Z\",\n \"to\": \"2024-07-29T15:51:28.071Z\"\n },\n \"lineItems\": [\n {\n \"reportCategory\": \"BILLING\",\n \"platformTenantId\": \"b8e2c4a6-1d3f-4e57-9a0b-7c6d5e4f3a21\",\n \"platformFullIdentifier\": \"my-platform.my-location\",\n \"reportId\": \"TenantUsageReports/my-platform.my-location:b8e2c4a6-1d3f-4e57-9a0b-7c6d5e4f3a21:2025-01-01Z\",\n \"entryDate\": \"2024-07-29T15:51:28.071Z\",\n \"period\": \"2025-01-01Z\",\n \"netAmount\": 0,\n \"baseNetAmount\": 0,\n \"baseCurrency\": \"EUR\",\n \"exchangeRate\": 0,\n \"currency\": \"USD\",\n \"sellerId\": \"STACKIT\",\n \"sellerProductGroup\": \"Compute\"\n }\n ],\n \"netAmounts\": [\n {\n \"currency\": \"USD\",\n \"amount\": 0,\n \"baseCurrency\": \"EUR\",\n \"baseNetAmount\": 0\n }\n ]\n },\n \"_links\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get chargeback by period and scope (deprecated) (v1)", "request": { "name": "Get chargeback by period and scope (deprecated)", "description": { "content": "Retrieve detailed information about a specific meshChargeback including line items and cost breakdown.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshchargebacks", ":chargebackPeriod", ":chargebackScope" ], "host": [ "{{endpoint}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{chargebackPeriod}}", "key": "chargebackPeriod", "description": { "content": "(Required) The period of the chargeback in YYYY-MM-DDZ format (e.g. '2025-02-01Z').", "type": "text/markdown" } }, { "disabled": false, "type": "any", "value": "{{chargebackScope}}", "key": "chargebackScope", "description": { "content": "(Required) The 'scope' consisting of partner identifier, workspace identifier and project identifier separated by ':' (e.g.\n'testPartner:testWorkspace:testProject').", "type": "text/markdown" } } ] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshchargeback.v1.hal+json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The chargeback", "originalRequest": { "name": "Get chargeback by period and scope (deprecated)", "description": { "content": "Retrieve detailed information about a specific meshChargeback including line items and cost breakdown.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshchargebacks", ":chargebackPeriod", ":chargebackScope" ], "host": [ "{{endpoint}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{chargebackPeriod}}", "key": "chargebackPeriod", "description": { "content": "(Required) The period of the chargeback in YYYY-MM-DDZ format (e.g. '2025-02-01Z').", "type": "text/markdown" } }, { "disabled": false, "type": "any", "value": "{{chargebackScope}}", "key": "chargebackScope", "description": { "content": "(Required) The 'scope' consisting of partner identifier, workspace identifier and project identifier separated by ':' (e.g.\n'testPartner:testWorkspace:testProject').", "type": "text/markdown" } } ] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshchargeback.v1.hal+json" } ], "method": "GET", "auth": null }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.meshcloud.api.meshchargeback.v1.hal+json" } ], "body": "{\n \"kind\": \"meshChargeback\",\n \"apiVersion\": \"v3\",\n \"metadata\": {\n \"name\": \"2025-01-01Z/my-partner:my-workspace:my-project\",\n \"createdOn\": \"2024-07-29T15:51:28.071Z\",\n \"finalized\": false,\n \"finalizationDate\": \"2024-07-29T15:51:28.071Z\",\n \"cancellationDate\": \"2024-07-29T15:51:28.071Z\",\n \"version\": 0\n },\n \"spec\": {\n \"workspaceIdentifier\": \"my-workspace\",\n \"customerIdentifier\": \"my-workspace\",\n \"projectIdentifier\": \"my-project\",\n \"period\": \"2025-01-01Z\",\n \"tags\": {}\n },\n \"status\": {\n \"timeframe\": {\n \"from\": \"2024-07-29T15:51:28.071Z\",\n \"to\": \"2024-07-29T15:51:28.071Z\"\n },\n \"lineItems\": [\n {\n \"reportCategory\": \"BILLING\",\n \"platformTenantId\": \"b8e2c4a6-1d3f-4e57-9a0b-7c6d5e4f3a21\",\n \"platformFullIdentifier\": \"my-platform.my-location\",\n \"reportId\": \"TenantUsageReports/my-platform.my-location:b8e2c4a6-1d3f-4e57-9a0b-7c6d5e4f3a21:2025-01-01Z\",\n \"entryDate\": \"2024-07-29T15:51:28.071Z\",\n \"period\": \"2025-01-01Z\",\n \"netAmount\": 0,\n \"baseNetAmount\": 0,\n \"baseCurrency\": \"EUR\",\n \"exchangeRate\": 0,\n \"currency\": \"USD\",\n \"sellerId\": \"STACKIT\",\n \"sellerProductGroup\": \"Compute\"\n }\n ],\n \"netAmounts\": [\n {\n \"currency\": \"USD\",\n \"amount\": 0,\n \"baseCurrency\": \"EUR\",\n \"baseNetAmount\": 0\n }\n ]\n },\n \"_links\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3927f07f-ae05-4f8e-b4f9-b1d45c97b90d", "name": "Resource Usage Reports", "description": { "content": "", "type": "text/markdown" }, "item": [ { "name": "Import Resource Usage Report", "request": { "name": "Import Resource Usage Report", "description": { "content": "Use this endpoint to provide cost data from external systems to meshStack. A meshResourceUsageReport will be\npicked up by the billing system of meshStack and subsequently included into regular meshTenantUsageReports.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshresourceusagereports", ":resourceUsageReportPlatformTenantId", ":resourceUsageReportPeriod" ], "host": [ "{{endpoint}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{resourceUsageReportPlatformTenantId}}", "key": "resourceUsageReportPlatformTenantId", "description": { "content": "(Required) The Platform Tenant ID of the tenant causing the costs.", "type": "text/markdown" } }, { "disabled": false, "type": "any", "value": "{{resourceUsageReportPeriod}}", "key": "resourceUsageReportPeriod", "description": { "content": "(Required) The month during which the costs have occurred, e.g. 2023-05-01Z for May 2023.", "type": "text/markdown" } } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.meshcloud.api.meshobjects.v1+json" }, { "key": "Accept", "value": "application/vnd.meshcloud.api.meshobjects.v1+json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"kind\": \"meshResourceUsageReport\",\n \"apiVersion\": \"v1\",\n \"fullPlatformIdentifier\": \"my-platform.my-location\",\n \"source\": \"stackit-billing-export\",\n \"lineItems\": [\n {\n \"productName\": \"Virtual Machine g1.2\",\n \"sellerId\": \"STACKIT\",\n \"sellerProductGroup\": \"Compute\",\n \"usageType\": \"CPU hours\",\n \"usageCost\": 0,\n \"usageQuantity\": 0,\n \"usageUnit\": \"h\",\n \"currency\": \"USD\",\n \"totalCost\": 0\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "The meshResourceUsageReport was imported. meshObject is always meshResourceUsageReport and status is SUCCESS.", "originalRequest": { "name": "Import Resource Usage Report", "description": { "content": "Use this endpoint to provide cost data from external systems to meshStack. A meshResourceUsageReport will be\npicked up by the billing system of meshStack and subsequently included into regular meshTenantUsageReports.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshresourceusagereports", ":resourceUsageReportPlatformTenantId", ":resourceUsageReportPeriod" ], "host": [ "{{endpoint}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{resourceUsageReportPlatformTenantId}}", "key": "resourceUsageReportPlatformTenantId", "description": { "content": "(Required) The Platform Tenant ID of the tenant causing the costs.", "type": "text/markdown" } }, { "disabled": false, "type": "any", "value": "{{resourceUsageReportPeriod}}", "key": "resourceUsageReportPeriod", "description": { "content": "(Required) The month during which the costs have occurred, e.g. 2023-05-01Z for May 2023.", "type": "text/markdown" } } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.meshcloud.api.meshobjects.v1+json" }, { "key": "Accept", "value": "application/vnd.meshcloud.api.meshobjects.v1+json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"kind\": \"meshResourceUsageReport\",\n \"apiVersion\": \"v1\",\n \"fullPlatformIdentifier\": \"my-platform.my-location\",\n \"source\": \"stackit-billing-export\",\n \"lineItems\": [\n {\n \"productName\": \"Virtual Machine g1.2\",\n \"sellerId\": \"STACKIT\",\n \"sellerProductGroup\": \"Compute\",\n \"usageType\": \"CPU hours\",\n \"usageCost\": 0,\n \"usageQuantity\": 0,\n \"usageUnit\": \"h\",\n \"currency\": \"USD\",\n \"totalCost\": 0\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.meshcloud.api.meshobjects.v1+json" } ], "body": "{\n \"meshObject\": \"meshWorkspace[my-workspace]\",\n \"status\": \"SUCCESS\",\n \"resultCode\": \"WORKSPACE_NOT_FOUND\",\n \"message\": \"\",\n \"remarks\": [\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4ed946ea-96fb-4595-b3ba-38aa056e9fcd", "name": "Tenant Usage Reports", "description": { "content": "", "type": "text/markdown" }, "item": [ { "name": "List tenant usage reports (deprecated) (v3)", "request": { "name": "List tenant usage reports (deprecated)", "description": { "content": "List all meshTenantUsageReports with optional filtering by workspace, project, and time period.\n\n**Note**: If no request parameters for filtering are specified, all meshTenantUsageReports, except for cancelled\nones, are returned. A meshTenantUsageReport gets cancelled, if any changes occur after finalization of it. A new\nmeshTenantUsageReport with an incremented version gets created in case of such an update. So the old one is\navailable as cancelled, and the new as finalized. By default, meshTenantUsageReports are sorted descending by\nperiod.\n\nA meshTenantUsageReport contains all cost and payment information as well as tags for one tenant in one period\n(month). Via the API, you receive more detailed information than via the UI. Besides tags and payment information,\nyou also get the seller information separated via line items in the meshTenantUsageReport.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshtenantusagereports" ], "host": [ "{{endpoint}}" ], "query": [ { "disabled": true, "key": "page", "value": "0", "description": { "content": "Zero-based index of the page to return.", "type": "text/markdown" } }, { "disabled": true, "key": "size", "value": "50", "description": { "content": "Number of elements per page. A larger size is reduced to the maximum.", "type": "text/markdown" } }, { "disabled": true, "key": "sort", "value": "period", "description": { "content": "Sort order as `,asc` or `,desc`, ascending if the direction is left out. Repeat the parameter to sort by several keys. Sortable keys: `period`, `platform`, `platformType`, `platformTenantId`, `ownedByWorkspace`, `ownedByProject`, `total`, `generatedAt`, `reportCategory`, `finalizedAt`, `cancelledAt`, `paymentMethodIdentifier`. Without `sort`, the order is `period,desc`.", "type": "text/markdown" } }, { "disabled": true, "key": "period", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the provided period in format YYYY-MM, e.g. `2025-01`.", "type": "text/markdown" } }, { "disabled": true, "key": "reportCategory", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the provided reportCategory.", "type": "text/markdown" } }, { "disabled": true, "key": "ownedByWorkspace", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the meshWorkspace with given identifier.", "type": "text/markdown" } }, { "disabled": true, "key": "ownedByProject", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the meshProject with given identifier. Make sure to\nalso filter for ownedByWorkspace, as a project identifier is only unique inside a workspace!", "type": "text/markdown" } }, { "disabled": true, "key": "isManaged", "value": "", "description": { "content": "Filter for meshTenantUsageReports that are either managed or not managed by meshStack! meshStack\ncollects all cost information from the cloud platform for all tenants. If a tenant is not managed by meshStack,\nit is an unmanaged tenant. If you provide `true` for this filter parameter, you only get meshTenantUsageReports\nfor tenants that are managed by meshStack. If you provide `false`, you only get meshTenantUsageReports of\nunmanaged tenants.", "type": "text/markdown" } }, { "disabled": true, "key": "platform", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the provided platform in the format\n`.`.", "type": "text/markdown" } }, { "disabled": true, "key": "platformType", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the provided platform type.", "type": "text/markdown" } }, { "disabled": true, "key": "platformTenantId", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to a certain tenant that can be identified via platform\ntenant ID.", "type": "text/markdown" } }, { "disabled": true, "key": "paymentMethodIdentifier", "value": "", "description": { "content": "Filter for meshTenantUsageReports that have the meshPaymentMethod with given identifier assigned. Use an\nempty or blank value to filter for meshTenantUsageReports without an assigned meshPaymentMethod.", "type": "text/markdown" } }, { "disabled": true, "key": "meshTenantId", "value": "", "description": { "content": "Filter for meshTenantUsageReports of the meshTenant with the given UUID.", "type": "text/markdown" } }, { "disabled": true, "key": "finalizedAfter", "value": "", "description": { "content": "Filter for meshTenantUsageReports that were finalized after the provided date (e.g.\n`2025-06-01T00:00:00Z`). You can use this filter to retrieve all meshTenantUsageReports finalized after your\nlast request for processing them in your billing system. You can e.g. provide the latest finalizationDate you\nreceived in your last request. You may then receive the newly finalized usage reports of the new period and\nprobably updated usage reports of previous periods. This filter parameter is exclusive, meaning it will only\nmatch reports that were finalized after the given date.", "type": "text/markdown" } }, { "disabled": true, "key": "cancelledAfter", "value": "", "description": { "content": "Filter for meshTenantUsageReports that were cancelled after the provided date (e.g.\n`2025-06-01T00:00:00Z`). When you apply this filter, you only get cancelled usage reports, meaning outdated data\nthat was already updated. This filter parameter is exclusive, meaning it will only match reports that were\ncancelled after the given date.", "type": "text/markdown" } }, { "disabled": true, "key": "status", "value": "", "description": { "content": "Filter for meshTenantUsageReports that are in the given state. You can e.g. use this filter to exclude\nmeshTenantUsageReports that have never been finalized yet (e.g. preview usage reports of the current month) or\nto get all usage reports that were UPDATED at least once. You can provide this parameter multiple times, e.g. to\nget only FINALIZED and UPDATED usage reports: `?status=FINALIZED&status=UPDATED`.", "type": "text/markdown" } }, { "disabled": true, "key": "showCancelled", "value": "", "description": { "content": "By default, cancelled meshTenantUsageReports are not included in the response. If you want to include\nthem, you can set this parameter to `true`. This is not required when you already filter for cancelledAfter.", "type": "text/markdown" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshtenantusagereport.v3.hal+json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The page of tenant usage reports", "originalRequest": { "name": "List tenant usage reports (deprecated)", "description": { "content": "List all meshTenantUsageReports with optional filtering by workspace, project, and time period.\n\n**Note**: If no request parameters for filtering are specified, all meshTenantUsageReports, except for cancelled\nones, are returned. A meshTenantUsageReport gets cancelled, if any changes occur after finalization of it. A new\nmeshTenantUsageReport with an incremented version gets created in case of such an update. So the old one is\navailable as cancelled, and the new as finalized. By default, meshTenantUsageReports are sorted descending by\nperiod.\n\nA meshTenantUsageReport contains all cost and payment information as well as tags for one tenant in one period\n(month). Via the API, you receive more detailed information than via the UI. Besides tags and payment information,\nyou also get the seller information separated via line items in the meshTenantUsageReport.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshtenantusagereports" ], "host": [ "{{endpoint}}" ], "query": [ { "disabled": true, "key": "page", "value": "0", "description": { "content": "Zero-based index of the page to return.", "type": "text/markdown" } }, { "disabled": true, "key": "size", "value": "50", "description": { "content": "Number of elements per page. A larger size is reduced to the maximum.", "type": "text/markdown" } }, { "disabled": true, "key": "sort", "value": "period", "description": { "content": "Sort order as `,asc` or `,desc`, ascending if the direction is left out. Repeat the parameter to sort by several keys. Sortable keys: `period`, `platform`, `platformType`, `platformTenantId`, `ownedByWorkspace`, `ownedByProject`, `total`, `generatedAt`, `reportCategory`, `finalizedAt`, `cancelledAt`, `paymentMethodIdentifier`. Without `sort`, the order is `period,desc`.", "type": "text/markdown" } }, { "disabled": true, "key": "period", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the provided period in format YYYY-MM, e.g. `2025-01`.", "type": "text/markdown" } }, { "disabled": true, "key": "reportCategory", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the provided reportCategory.", "type": "text/markdown" } }, { "disabled": true, "key": "ownedByWorkspace", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the meshWorkspace with given identifier.", "type": "text/markdown" } }, { "disabled": true, "key": "ownedByProject", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the meshProject with given identifier. Make sure to\nalso filter for ownedByWorkspace, as a project identifier is only unique inside a workspace!", "type": "text/markdown" } }, { "disabled": true, "key": "isManaged", "value": "", "description": { "content": "Filter for meshTenantUsageReports that are either managed or not managed by meshStack! meshStack\ncollects all cost information from the cloud platform for all tenants. If a tenant is not managed by meshStack,\nit is an unmanaged tenant. If you provide `true` for this filter parameter, you only get meshTenantUsageReports\nfor tenants that are managed by meshStack. If you provide `false`, you only get meshTenantUsageReports of\nunmanaged tenants.", "type": "text/markdown" } }, { "disabled": true, "key": "platform", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the provided platform in the format\n`.`.", "type": "text/markdown" } }, { "disabled": true, "key": "platformType", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the provided platform type.", "type": "text/markdown" } }, { "disabled": true, "key": "platformTenantId", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to a certain tenant that can be identified via platform\ntenant ID.", "type": "text/markdown" } }, { "disabled": true, "key": "paymentMethodIdentifier", "value": "", "description": { "content": "Filter for meshTenantUsageReports that have the meshPaymentMethod with given identifier assigned. Use an\nempty or blank value to filter for meshTenantUsageReports without an assigned meshPaymentMethod.", "type": "text/markdown" } }, { "disabled": true, "key": "meshTenantId", "value": "", "description": { "content": "Filter for meshTenantUsageReports of the meshTenant with the given UUID.", "type": "text/markdown" } }, { "disabled": true, "key": "finalizedAfter", "value": "", "description": { "content": "Filter for meshTenantUsageReports that were finalized after the provided date (e.g.\n`2025-06-01T00:00:00Z`). You can use this filter to retrieve all meshTenantUsageReports finalized after your\nlast request for processing them in your billing system. You can e.g. provide the latest finalizationDate you\nreceived in your last request. You may then receive the newly finalized usage reports of the new period and\nprobably updated usage reports of previous periods. This filter parameter is exclusive, meaning it will only\nmatch reports that were finalized after the given date.", "type": "text/markdown" } }, { "disabled": true, "key": "cancelledAfter", "value": "", "description": { "content": "Filter for meshTenantUsageReports that were cancelled after the provided date (e.g.\n`2025-06-01T00:00:00Z`). When you apply this filter, you only get cancelled usage reports, meaning outdated data\nthat was already updated. This filter parameter is exclusive, meaning it will only match reports that were\ncancelled after the given date.", "type": "text/markdown" } }, { "disabled": true, "key": "status", "value": "", "description": { "content": "Filter for meshTenantUsageReports that are in the given state. You can e.g. use this filter to exclude\nmeshTenantUsageReports that have never been finalized yet (e.g. preview usage reports of the current month) or\nto get all usage reports that were UPDATED at least once. You can provide this parameter multiple times, e.g. to\nget only FINALIZED and UPDATED usage reports: `?status=FINALIZED&status=UPDATED`.", "type": "text/markdown" } }, { "disabled": true, "key": "showCancelled", "value": "", "description": { "content": "By default, cancelled meshTenantUsageReports are not included in the response. If you want to include\nthem, you can set this parameter to `true`. This is not required when you already filter for cancelledAfter.", "type": "text/markdown" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshtenantusagereport.v3.hal+json" } ], "method": "GET", "auth": null }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.meshcloud.api.meshtenantusagereport.v3.hal+json" } ], "body": "{\n \"_embedded\": {\n \"meshTenantUsageReports\": [\n {\n \"kind\": \"meshTenantUsageReport\",\n \"apiVersion\": \"v3\",\n \"metadata\": {\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"ownedByWorkspace\": \"my-workspace\",\n \"ownedByProject\": \"my-project\",\n \"createdAt\": \"2024-07-29T15:51:28.071Z\"\n },\n \"spec\": {\n \"period\": \"2025-01\",\n \"reportCategory\": \"BILLING\",\n \"platformType\": \"Custom\",\n \"platform\": \"my-platform.my-location\",\n \"platformTenantId\": \"b8e2c4a6-1d3f-4e57-9a0b-7c6d5e4f3a21\",\n \"version\": 0\n },\n \"status\": {\n \"generatedAt\": \"2024-07-29T15:51:28.071Z\",\n \"finalizedAt\": \"2024-07-29T15:51:28.071Z\",\n \"cancelledAt\": \"2024-07-29T15:51:28.071Z\",\n \"paymentMethod\": {\n \"identifier\": \"my-payment-method\",\n \"name\": \"my-payment-method\",\n \"amount\": 0,\n \"expirationDate\": \"2024-07-29T15:51:28.071Z\"\n },\n \"timeframe\": {\n \"from\": \"2024-07-29T15:51:28.071Z\",\n \"to\": \"2024-07-29T15:51:28.071Z\"\n },\n \"tags\": {},\n \"lineItems\": [\n {\n \"netAmount\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"baseAmount\": 0,\n \"baseCurrency\": \"EUR\",\n \"exchangeRate\": 0\n },\n \"sellerId\": \"STACKIT\",\n \"sellerProductGroup\": \"Compute\"\n }\n ]\n },\n \"_links\": {}\n }\n ]\n },\n \"_links\": {},\n \"page\": {\n \"size\": 0,\n \"totalElements\": 0,\n \"totalPages\": 0,\n \"number\": 0\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List tenant usage reports (deprecated) (v2)", "request": { "name": "List tenant usage reports (deprecated)", "description": { "content": "List all meshTenantUsageReports with optional filtering by workspace, project, and time period.\n\n**Note**: If no request parameters for filtering are specified, all meshTenantUsageReports, except for cancelled\nones, are returned. A meshTenantUsageReport gets cancelled, if any changes occur after finalization of it. A new\nmeshTenantUsageReport with an incremented version gets created in case of such an update. So the old one is\navailable as cancelled, and the new as finalized. By default, meshTenantUsageReports are sorted descending by\nperiod.\n\nA meshTenantUsageReport contains all cost and payment information as well as tags for one tenant in one period\n(month). Via the API, you receive more detailed information than via the UI. Besides tags and payment information,\nyou also get the seller information separated via line items in the meshTenantUsageReport.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshtenantusagereports" ], "host": [ "{{endpoint}}" ], "query": [ { "disabled": true, "key": "page", "value": "0", "description": { "content": "Zero-based index of the page to return.", "type": "text/markdown" } }, { "disabled": true, "key": "size", "value": "50", "description": { "content": "Number of elements per page. A larger size is reduced to the maximum.", "type": "text/markdown" } }, { "disabled": true, "key": "sort", "value": "period", "description": { "content": "Sort order as `,asc` or `,desc`, ascending if the direction is left out. Repeat the parameter to sort by several keys. Sortable keys: `period`, `platformFullIdentifier`, `workspaceIdentifier`, `projectIdentifier`, `reportCategory`, `paymentIdentifier`, `customerIdentifier`. Without `sort`, the order is `period,desc`.", "type": "text/markdown" } }, { "disabled": true, "key": "workspaceIdentifier", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the meshWorkspace with given identifier.", "type": "text/markdown" } }, { "disabled": true, "key": "projectIdentifier", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the meshProject with given identifier.", "type": "text/markdown" } }, { "disabled": true, "key": "platformFullIdentifier", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the provided platform in the format\n`.`.", "type": "text/markdown" } }, { "disabled": true, "key": "period", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the provided period in format YYYY-MM-DDZ, e.g.\n`2025-01-01Z`.", "type": "text/markdown" } }, { "disabled": true, "key": "reportCategory", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the provided reportCategory.", "type": "text/markdown" } }, { "disabled": true, "key": "paymentIdentifier", "value": "", "description": { "content": "Filter for meshTenantUsageReports that have the meshPaymentMethod with given identifier assigned.", "type": "text/markdown" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshtenantusagereport.v2.hal+json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The page of tenant usage reports", "originalRequest": { "name": "List tenant usage reports (deprecated)", "description": { "content": "List all meshTenantUsageReports with optional filtering by workspace, project, and time period.\n\n**Note**: If no request parameters for filtering are specified, all meshTenantUsageReports, except for cancelled\nones, are returned. A meshTenantUsageReport gets cancelled, if any changes occur after finalization of it. A new\nmeshTenantUsageReport with an incremented version gets created in case of such an update. So the old one is\navailable as cancelled, and the new as finalized. By default, meshTenantUsageReports are sorted descending by\nperiod.\n\nA meshTenantUsageReport contains all cost and payment information as well as tags for one tenant in one period\n(month). Via the API, you receive more detailed information than via the UI. Besides tags and payment information,\nyou also get the seller information separated via line items in the meshTenantUsageReport.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshtenantusagereports" ], "host": [ "{{endpoint}}" ], "query": [ { "disabled": true, "key": "page", "value": "0", "description": { "content": "Zero-based index of the page to return.", "type": "text/markdown" } }, { "disabled": true, "key": "size", "value": "50", "description": { "content": "Number of elements per page. A larger size is reduced to the maximum.", "type": "text/markdown" } }, { "disabled": true, "key": "sort", "value": "period", "description": { "content": "Sort order as `,asc` or `,desc`, ascending if the direction is left out. Repeat the parameter to sort by several keys. Sortable keys: `period`, `platformFullIdentifier`, `workspaceIdentifier`, `projectIdentifier`, `reportCategory`, `paymentIdentifier`, `customerIdentifier`. Without `sort`, the order is `period,desc`.", "type": "text/markdown" } }, { "disabled": true, "key": "workspaceIdentifier", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the meshWorkspace with given identifier.", "type": "text/markdown" } }, { "disabled": true, "key": "projectIdentifier", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the meshProject with given identifier.", "type": "text/markdown" } }, { "disabled": true, "key": "platformFullIdentifier", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the provided platform in the format\n`.`.", "type": "text/markdown" } }, { "disabled": true, "key": "period", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the provided period in format YYYY-MM-DDZ, e.g.\n`2025-01-01Z`.", "type": "text/markdown" } }, { "disabled": true, "key": "reportCategory", "value": "", "description": { "content": "Filter for meshTenantUsageReports that belong to the provided reportCategory.", "type": "text/markdown" } }, { "disabled": true, "key": "paymentIdentifier", "value": "", "description": { "content": "Filter for meshTenantUsageReports that have the meshPaymentMethod with given identifier assigned.", "type": "text/markdown" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshtenantusagereport.v2.hal+json" } ], "method": "GET", "auth": null }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.meshcloud.api.meshtenantusagereport.v2.hal+json" } ], "body": "{\n \"_embedded\": {\n \"meshTenantUsageReports\": [\n {\n \"kind\": \"meshTenantUsageReport\",\n \"apiVersion\": \"v2\",\n \"metadata\": {\n \"name\": \"my-platform.my-location:b8e2c4a6-1d3f-4e57-9a0b-7c6d5e4f3a21:2025-01-01Z\",\n \"lastModified\": \"2024-07-29T15:51:28.071Z\",\n \"finalized\": false\n },\n \"spec\": {\n \"period\": \"2025-01-01Z\",\n \"reportCategory\": \"BILLING\",\n \"platformType\": \"Custom\",\n \"platformFullIdentifier\": \"my-platform.my-location\",\n \"platformTenantId\": \"b8e2c4a6-1d3f-4e57-9a0b-7c6d5e4f3a21\"\n },\n \"status\": {\n \"workspaceIdentifier\": \"my-workspace\",\n \"customerIdentifier\": \"my-workspace\",\n \"projectIdentifier\": \"my-project\",\n \"timeframe\": {\n \"from\": \"2024-07-29T15:51:28.071Z\",\n \"to\": \"2024-07-29T15:51:28.071Z\"\n },\n \"netAmounts\": [\n {\n \"currency\": \"USD\",\n \"amount\": 0,\n \"baseCurrency\": \"EUR\",\n \"baseAmount\": 0\n }\n ]\n },\n \"_links\": {}\n }\n ]\n },\n \"_links\": {},\n \"page\": {\n \"size\": 0,\n \"totalElements\": 0,\n \"totalPages\": 0,\n \"number\": 0\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get tenant usage report (deprecated)", "request": { "name": "Get tenant usage report (deprecated)", "description": { "content": "Retrieve detailed information about a specific meshTenantUsageReport including line items and payment details.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshtenantusagereports", ":tenantUsageReport" ], "host": [ "{{endpoint}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{tenantUsageReport}}", "key": "tenantUsageReport", "description": { "content": "(Required) The UUID of the meshTenantUsageReport.", "type": "text/markdown" } } ] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshtenantusagereport.v3.hal+json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The tenant usage report", "originalRequest": { "name": "Get tenant usage report (deprecated)", "description": { "content": "Retrieve detailed information about a specific meshTenantUsageReport including line items and payment details.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshtenantusagereports", ":tenantUsageReport" ], "host": [ "{{endpoint}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{tenantUsageReport}}", "key": "tenantUsageReport", "description": { "content": "(Required) The UUID of the meshTenantUsageReport.", "type": "text/markdown" } } ] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshtenantusagereport.v3.hal+json" } ], "method": "GET", "auth": null }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.meshcloud.api.meshtenantusagereport.v3.hal+json" } ], "body": "{\n \"kind\": \"meshTenantUsageReport\",\n \"apiVersion\": \"v3\",\n \"metadata\": {\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"ownedByWorkspace\": \"my-workspace\",\n \"ownedByProject\": \"my-project\",\n \"createdAt\": \"2024-07-29T15:51:28.071Z\"\n },\n \"spec\": {\n \"period\": \"2025-01\",\n \"reportCategory\": \"BILLING\",\n \"platformType\": \"Custom\",\n \"platform\": \"my-platform.my-location\",\n \"platformTenantId\": \"b8e2c4a6-1d3f-4e57-9a0b-7c6d5e4f3a21\",\n \"version\": 0\n },\n \"status\": {\n \"generatedAt\": \"2024-07-29T15:51:28.071Z\",\n \"finalizedAt\": \"2024-07-29T15:51:28.071Z\",\n \"cancelledAt\": \"2024-07-29T15:51:28.071Z\",\n \"paymentMethod\": {\n \"identifier\": \"my-payment-method\",\n \"name\": \"my-payment-method\",\n \"amount\": 0,\n \"expirationDate\": \"2024-07-29T15:51:28.071Z\"\n },\n \"timeframe\": {\n \"from\": \"2024-07-29T15:51:28.071Z\",\n \"to\": \"2024-07-29T15:51:28.071Z\"\n },\n \"tags\": {},\n \"lineItems\": [\n {\n \"netAmount\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"baseAmount\": 0,\n \"baseCurrency\": \"EUR\",\n \"exchangeRate\": 0\n },\n \"sellerId\": \"STACKIT\",\n \"sellerProductGroup\": \"Compute\"\n }\n ]\n },\n \"_links\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get tenant usage report by tenant and period (deprecated)", "request": { "name": "Get tenant usage report by tenant and period (deprecated)", "description": { "content": "Retrieve a specific meshTenantUsageReport in version v2 by its tenant and period. The self link of a v2\nmeshTenantUsageReport points here. Only the report of the `BILLING` report category is returned.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshtenantusagereports", ":tenantUsageReportTenant", ":tenantUsageReportPeriod" ], "host": [ "{{endpoint}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{tenantUsageReportTenant}}", "key": "tenantUsageReportTenant", "description": { "content": "(Required) The tenant of the meshTenantUsageReport as `:` (e.g.\n`aws.eu-central-1:123456789012`).", "type": "text/markdown" } }, { "disabled": false, "type": "any", "value": "{{tenantUsageReportPeriod}}", "key": "tenantUsageReportPeriod", "description": { "content": "(Required) The period of the meshTenantUsageReport in YYYY-MM-DDZ format (e.g. '2025-02-01Z').", "type": "text/markdown" } } ] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshtenantusagereport.v2.hal+json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The tenant usage report", "originalRequest": { "name": "Get tenant usage report by tenant and period (deprecated)", "description": { "content": "Retrieve a specific meshTenantUsageReport in version v2 by its tenant and period. The self link of a v2\nmeshTenantUsageReport points here. Only the report of the `BILLING` report category is returned.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects", "meshtenantusagereports", ":tenantUsageReportTenant", ":tenantUsageReportPeriod" ], "host": [ "{{endpoint}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "{{tenantUsageReportTenant}}", "key": "tenantUsageReportTenant", "description": { "content": "(Required) The tenant of the meshTenantUsageReport as `:` (e.g.\n`aws.eu-central-1:123456789012`).", "type": "text/markdown" } }, { "disabled": false, "type": "any", "value": "{{tenantUsageReportPeriod}}", "key": "tenantUsageReportPeriod", "description": { "content": "(Required) The period of the meshTenantUsageReport in YYYY-MM-DDZ format (e.g. '2025-02-01Z').", "type": "text/markdown" } } ] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshtenantusagereport.v2.hal+json" } ], "method": "GET", "auth": null }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.meshcloud.api.meshtenantusagereport.v2.hal+json" } ], "body": "{\n \"kind\": \"meshTenantUsageReport\",\n \"apiVersion\": \"v2\",\n \"metadata\": {\n \"name\": \"my-platform.my-location:b8e2c4a6-1d3f-4e57-9a0b-7c6d5e4f3a21:2025-01-01Z\",\n \"lastModified\": \"2024-07-29T15:51:28.071Z\",\n \"finalized\": false\n },\n \"spec\": {\n \"period\": \"2025-01-01Z\",\n \"reportCategory\": \"BILLING\",\n \"platformType\": \"Custom\",\n \"platformFullIdentifier\": \"my-platform.my-location\",\n \"platformTenantId\": \"b8e2c4a6-1d3f-4e57-9a0b-7c6d5e4f3a21\"\n },\n \"status\": {\n \"workspaceIdentifier\": \"my-workspace\",\n \"customerIdentifier\": \"my-workspace\",\n \"projectIdentifier\": \"my-project\",\n \"timeframe\": {\n \"from\": \"2024-07-29T15:51:28.071Z\",\n \"to\": \"2024-07-29T15:51:28.071Z\"\n },\n \"netAmounts\": [\n {\n \"currency\": \"USD\",\n \"amount\": 0,\n \"baseCurrency\": \"EUR\",\n \"baseAmount\": 0\n }\n ]\n },\n \"_links\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "590e1b45-01af-4c54-af0a-c09c38f9f75a", "name": "Roots", "description": { "content": "", "type": "text/markdown" }, "item": [ { "name": "API Root", "request": { "name": "API Root", "description": { "content": "Access the root endpoint of the metering API to discover the available metering resources.", "type": "text/markdown" }, "url": { "path": [ "api" ], "host": [ "{{endpoint}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.v1.hal+json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The links to the available metering resources", "originalRequest": { "name": "API Root", "description": { "content": "Access the root endpoint of the metering API to discover the available metering resources.", "type": "text/markdown" }, "url": { "path": [ "api" ], "host": [ "{{endpoint}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.v1.hal+json" } ], "method": "GET", "auth": null }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.meshcloud.api.v1.hal+json" } ], "body": "{\n \"_links\": {\n \"meshobjects\": {\n \"href\": \"https://example.meshstack.io/api/meshobjects\"\n },\n \"self\": {\n \"href\": \"https://example.meshstack.io/api\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get meshObjects root (v2)", "request": { "name": "Get meshObjects root", "description": { "content": "Access the root endpoint of the metering meshObjects API to discover the available metering meshObject types.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects" ], "host": [ "{{endpoint}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshobjects.v2.hal+json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The links to the available metering meshObject types", "originalRequest": { "name": "Get meshObjects root", "description": { "content": "Access the root endpoint of the metering meshObjects API to discover the available metering meshObject types.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects" ], "host": [ "{{endpoint}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshobjects.v2.hal+json" } ], "method": "GET", "auth": null }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.meshcloud.api.meshobjects.v2.hal+json" } ], "body": "{\n \"_links\": {\n \"meshchargebacks\": {\n \"href\": \"https://example.meshstack.io/api/meshobjects/meshchargebacks{?workspaceIdentifier,projectIdentifier,period,finalized,finalizedSince,cancelledSince}\",\n \"templated\": true\n },\n \"meshtenantusagereports\": {\n \"href\": \"https://example.meshstack.io/api/meshobjects/meshtenantusagereports{?ownedByWorkspace,ownedByProject,isManaged,platform,platformType,platformTenantId,period,reportCategory,paymentMethodIdentifier,meshTenantId,finalizedAfter,cancelledAfter,status,showCancelled}\",\n \"templated\": true\n },\n \"self\": {\n \"href\": \"https://example.meshstack.io/api/meshobjects\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get meshObjects root (v1)", "request": { "name": "Get meshObjects root", "description": { "content": "Access the root endpoint of the metering meshObjects API to discover the available metering meshObject types.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects" ], "host": [ "{{endpoint}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshobjects.v1.hal+json" } ], "method": "GET", "auth": null }, "response": [ { "name": "The links to the available metering meshObject types", "originalRequest": { "name": "Get meshObjects root", "description": { "content": "Access the root endpoint of the metering meshObjects API to discover the available metering meshObject types.", "type": "text/markdown" }, "url": { "path": [ "api", "meshobjects" ], "host": [ "{{endpoint}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.meshcloud.api.meshobjects.v1.hal+json" } ], "method": "GET", "auth": null }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.meshcloud.api.meshobjects.v1.hal+json" } ], "body": "{\n \"_links\": {\n \"meshchargebacks\": {\n \"href\": \"https://example.meshstack.io/api/meshobjects/meshchargebacks{?workspaceIdentifier,projectIdentifier,period,finalized,finalizedSince,cancelledSince}\",\n \"templated\": true\n },\n \"meshtenantusagereports\": {\n \"href\": \"https://example.meshstack.io/api/meshobjects/meshtenantusagereports{?ownedByWorkspace,ownedByProject,isManaged,platform,platformType,platformTenantId,period,reportCategory,paymentMethodIdentifier,meshTenantId,finalizedAfter,cancelledAfter,status,showCancelled}\",\n \"templated\": true\n },\n \"self\": {\n \"href\": \"https://example.meshstack.io/api/meshobjects\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "description": { "content": "The URL of your meshStack API.", "type": "text/markdown" }, "type": "any", "value": "https://example.meshstack.io", "key": "endpoint" }, { "key": "chargebackPeriod", "value": "" }, { "key": "chargebackScope", "value": "" }, { "key": "resourceUsageReportPlatformTenantId", "value": "" }, { "key": "resourceUsageReportPeriod", "value": "" }, { "key": "tenantUsageReport", "value": "" }, { "key": "tenantUsageReportTenant", "value": "" }, { "key": "tenantUsageReportPeriod", "value": "" }, { "key": "basicAuthUsername", "value": "" }, { "key": "basicAuthPassword", "value": "" } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}" }, { "key": "password", "value": "{{basicAuthPassword}}" } ] }, "info": { "name": "meshMetering API documentation", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The metering API gives you the costs and usage that meshStack meters. Read meshChargebacks for the costs\nthat meshStack charges back to each project per billing period, and meshTenantUsageReports for the usage\nand costs of each tenant per period. Send meshResourceUsageReports to add cost data from other systems;\nmeshStack includes them in the tenant usage reports.\n\nLike the meshObject API, it versions each endpoint through the media types in the `Accept` and\n`Content-Type` headers. It takes Basic authentication with an API user. See the\n[API introduction](https://docs.meshcloud.io/api/introduction) to get started.", "type": "text/markdown" } } }