{ "info": { "_postman_id": "83eeed4f-fe0d-43c2-9610-fbe7662194e9", "name": "Soracom Billing API", "description": "Retrieve usage charges, daily bill items, summaries, payment methods, coupons, orders, and shipping addresses.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:18:39.000Z", "updatedAt": "2026-06-05T15:18:39.000Z", "lastUpdatedBy": "35240", "uid": "35240-83eeed4f-fe0d-43c2-9610-fbe7662194e9" }, "item": [ { "name": "bills", "item": [ { "name": "{yyyyMM}", "item": [ { "name": "daily", "item": [ { "name": "Get a daily bill", "id": "ab63f183-dc6b-4548-9269-df70ccda28c4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bills/:yyyyMM/daily", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":yyyyMM", "daily" ], "variable": [ { "id": "1d42f0cf-7ab3-456c-829c-d386d9940a32", "key": "yyyyMM", "value": "", "description": "(Required) Target year and month" } ] }, "description": "Gets a daily bill for the specified month. Fees charged on a monthly basis cannot be retrieved. If you specify current month (a month for which the fee has not yet been finalized), a preliminary value will be returned.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "250ac54d-8841-4a3d-853e-137405985d49", "name": "Daily billing information for the specified month.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/bills/:yyyyMM/daily", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":yyyyMM", "daily" ], "variable": [ { "key": "yyyyMM" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"billList\": [\n {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"date\": \"\"\n },\n {\n \"amount\": \"\",\n \"currency\": \"JPY\",\n \"date\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-250ac54d-8841-4a3d-853e-137405985d49" }, { "id": "0889f93c-7174-448a-afba-ad130e2b3c00", "name": "Bill not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/bills/:yyyyMM/daily", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":yyyyMM", "daily" ], "variable": [ { "key": "yyyyMM" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-0889f93c-7174-448a-afba-ad130e2b3c00" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-ab63f183-dc6b-4548-9269-df70ccda28c4" } ], "id": "7df03dcb-2255-464f-b589-541683df310e", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-7df03dcb-2255-464f-b589-541683df310e" }, { "name": "export", "item": [ { "name": "Export historical Detailed billing CSV to dedicated storage", "id": "7580a5f2-e324-4903-859b-6ef09043138d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bills/:yyyyMM/export?export_mode=async", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":yyyyMM", "export" ], "query": [ { "description": "Specify how to get the URL to download the billing details CSV.\n\n- `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [Files:getExportedFile API](#!/Files/getExportedFile) to get the URL. If the file size of the billing details CSV is huge, use `async`.\n- `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the billing details CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`.\n", "key": "export_mode", "value": "async" } ], "variable": [ { "id": "935aeb7b-0fb9-4e9d-9745-af6177334671", "key": "yyyyMM", "value": "", "description": "(Required) Target year and month" } ] }, "description": "Export historical [Detailed billing CSV](/en/docs/account/billing/#detailed-billing-csv) to dedicated storage and issue URL to download.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "3bee0d87-6a36-421c-86eb-b79b687ff7db", "name": "Export process successfully initiated. Contains the download URL or export ID.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/bills/:yyyyMM/export?export_mode=async", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":yyyyMM", "export" ], "query": [ { "description": "Specify how to get the URL to download the billing details CSV.\n\n- `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [Files:getExportedFile API](#!/Files/getExportedFile) to get the URL. If the file size of the billing details CSV is huge, use `async`.\n- `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the billing details CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`.\n", "key": "export_mode", "value": "async" } ], "variable": [ { "key": "yyyyMM" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"exportedFileId\": \"\",\n \"exportedFilePath\": \"\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-3bee0d87-6a36-421c-86eb-b79b687ff7db" }, { "id": "f4449c3a-6dc8-4d2c-b4b3-9df4b60e6f8f", "name": "Bill not found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/bills/:yyyyMM/export?export_mode=async", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":yyyyMM", "export" ], "query": [ { "description": "Specify how to get the URL to download the billing details CSV.\n\n- `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [Files:getExportedFile API](#!/Files/getExportedFile) to get the URL. If the file size of the billing details CSV is huge, use `async`.\n- `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the billing details CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`.\n", "key": "export_mode", "value": "async" } ], "variable": [ { "key": "yyyyMM" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-f4449c3a-6dc8-4d2c-b4b3-9df4b60e6f8f" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-7580a5f2-e324-4903-859b-6ef09043138d" } ], "id": "6b11dd55-d0cf-4c88-8281-093eeecae1df", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-6b11dd55-d0cf-4c88-8281-093eeecae1df" }, { "name": "Gets a finalized past billing history for the specified month", "id": "f5183c0d-59e8-4bcf-98af-2a03774225ae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bills/:yyyyMM", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":yyyyMM" ], "variable": [ { "id": "16ef9bd2-fcce-4877-8e97-e0b539a19309", "key": "yyyyMM", "value": "", "description": "(Required) Target year and month" } ] }, "description": "Gets a finalized past billing history for the specified month. If you specify current month (the month in which the usage fee has not yet been finalized), you will get the preliminary value.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "408d9212-3280-4cc1-86e1-42c812d88fef", "name": "The billing history for the specified month.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/bills/:yyyyMM", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":yyyyMM" ], "variable": [ { "key": "yyyyMM" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"amount\": \"\",\n \"appliedCouponAmount\": \"\",\n \"currency\": \"EUR\",\n \"paymentStatus\": \"refunding\",\n \"paymentTransactionId\": \"\",\n \"state\": \"temporary\",\n \"yearMonth\": \"\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-408d9212-3280-4cc1-86e1-42c812d88fef" }, { "id": "242a6128-7125-4761-a396-8ac5756acb44", "name": "- The billing history for the specified month has not been finalized.\n- There is no charge for the specified month.\n", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/bills/:yyyyMM", "host": [ "{{baseUrl}}" ], "path": [ "bills", ":yyyyMM" ], "variable": [ { "key": "yyyyMM" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-242a6128-7125-4761-a396-8ac5756acb44" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-f5183c0d-59e8-4bcf-98af-2a03774225ae" } ], "id": "b37b113b-d250-4182-9a98-8123972ddb88", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-b37b113b-d250-4182-9a98-8123972ddb88" }, { "name": "latest", "item": [ { "name": "export", "item": [ { "name": "Export latest billing CSV file to S3", "id": "0d8b9615-3478-4ad9-a675-49543a3bf52f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bills/latest/export?export_mode=async", "host": [ "{{baseUrl}}" ], "path": [ "bills", "latest", "export" ], "query": [ { "description": "Specify how to get the URL to download the billing details CSV.\n\n- `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [Files:getExportedFile API](#!/Files/getExportedFile) to get the URL. If the file size of the billing details CSV is huge, use `async`.\n- `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the billing details CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`.\n", "key": "export_mode", "value": "async" } ] }, "description": "Export [Detailed Billing CSV](/en/docs/account/billing/#detailed-billing-csv) for current month (the month in which the usage fee has not yet been finalized) to dedicated storage and issue a URL to download it. The fees will be finalized by the second business day of the following month. The Detailed billing CSV exported using this API will output preliminary values." }, "response": [ { "id": "cfe0a776-7475-4d60-83f9-af055b8e21af", "name": "Export process successfully initiated. Contains the download URL or export ID.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/bills/latest/export?export_mode=async", "host": [ "{{baseUrl}}" ], "path": [ "bills", "latest", "export" ], "query": [ { "description": "Specify how to get the URL to download the billing details CSV.\n\n- `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [Files:getExportedFile API](#!/Files/getExportedFile) to get the URL. If the file size of the billing details CSV is huge, use `async`.\n- `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the billing details CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`.\n", "key": "export_mode", "value": "async" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"exportedFileId\": \"\",\n \"exportedFilePath\": \"\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-cfe0a776-7475-4d60-83f9-af055b8e21af" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-0d8b9615-3478-4ad9-a675-49543a3bf52f" } ], "id": "2e6a94cc-cb6a-4815-94ac-4958720ae2a2", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-2e6a94cc-cb6a-4815-94ac-4958720ae2a2" }, { "name": "Get latest bill", "id": "b686eee5-3dff-407b-89b6-52a5da8c3af7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bills/latest", "host": [ "{{baseUrl}}" ], "path": [ "bills", "latest" ] }, "description": "Retrieves the preliminary usage fee for the current month (the month in which the usage fee has not yet been finalized)." }, "response": [ { "id": "248bc79f-ac58-4b4e-a8ba-131045547919", "name": "The latest billing information for the current month.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/bills/latest", "host": [ "{{baseUrl}}" ], "path": [ "bills", "latest" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"lastEvaluatedTime\": \"\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-248bc79f-ac58-4b4e-a8ba-131045547919" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-b686eee5-3dff-407b-89b6-52a5da8c3af7" } ], "id": "cc7fb11e-85fa-4aa4-b0eb-523b7196b628", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-cc7fb11e-85fa-4aa4-b0eb-523b7196b628" }, { "name": "summaries", "item": [ { "name": "bill_items", "item": [ { "name": "Gets a billing summary of bill items.", "id": "c53ebba1-4fae-4828-a9f6-f2bad21ce0b7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bills/summaries/bill_items", "host": [ "{{baseUrl}}" ], "path": [ "bills", "summaries", "bill_items" ] }, "description": "Get a billing summary of bill items for the last 4 months (this month to 3 months ago). Sorted by date from newest to oldest.\n\nThe summary you can get from this API is equivalent to the usage fees displayed in the [COSTS BY SERVICE] panel of the Billing Dashboard. For more information, please refer to [Billing Information](/en/docs/account/billing/).\n" }, "response": [ { "id": "e1b86db2-a102-47ce-9248-10886a20a8ce", "name": "A billing summary of bill items for the last 4 months.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/bills/summaries/bill_items", "host": [ "{{baseUrl}}" ], "path": [ "bills", "summaries", "bill_items" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"costBreakdownList\": [\n {\n \"amount\": \"\",\n \"billItemCategory\": \"\",\n \"billItemName\": \"\"\n },\n {\n \"amount\": \"\",\n \"billItemCategory\": \"\",\n \"billItemName\": \"\"\n }\n ],\n \"currency\": \"USD\",\n \"updatedTime\": \"\",\n \"yearMonth\": \"\"\n },\n {\n \"costBreakdownList\": [\n {\n \"amount\": \"\",\n \"billItemCategory\": \"\",\n \"billItemName\": \"\"\n },\n {\n \"amount\": \"\",\n \"billItemCategory\": \"\",\n \"billItemName\": \"\"\n }\n ],\n \"currency\": \"USD\",\n \"updatedTime\": \"\",\n \"yearMonth\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-e1b86db2-a102-47ce-9248-10886a20a8ce" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-c53ebba1-4fae-4828-a9f6-f2bad21ce0b7" } ], "id": "a1362ded-a17f-452c-8d7f-7791f28d4d13", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-a1362ded-a17f-452c-8d7f-7791f28d4d13" }, { "name": "sims", "item": [ { "name": "Gets a billing summary of SIMs", "id": "72cc9ada-285f-4032-ad3d-3143af06b946", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bills/summaries/sims", "host": [ "{{baseUrl}}" ], "path": [ "bills", "summaries", "sims" ] }, "description": "Get a billing summary of SIMs for the last 4 months (current month to 3 months ago). Sorted by date from newest to oldest.\n\nThe summary you get from this API is equivalent to the rates displayed in the [COSTS PER SIM (TOP 100)] panel of the Rates Dashboard. For more information, please refer to [Billing Information](/en/docs/account/billing/).\n" }, "response": [ { "id": "56d46a31-0cf1-4896-9eb9-9f818a84d492", "name": "A billing summary of SIMs for the last 4 months.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/bills/summaries/sims", "host": [ "{{baseUrl}}" ], "path": [ "bills", "summaries", "sims" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"costBreakdownList\": [\n {\n \"amount\": \"\",\n \"simId\": \"\"\n },\n {\n \"amount\": \"\",\n \"simId\": \"\"\n }\n ],\n \"currency\": \"JPY\",\n \"updatedTime\": \"\",\n \"yearMonth\": \"\"\n },\n {\n \"costBreakdownList\": [\n {\n \"amount\": \"\",\n \"simId\": \"\"\n },\n {\n \"amount\": \"\",\n \"simId\": \"\"\n }\n ],\n \"currency\": \"USD\",\n \"updatedTime\": \"\",\n \"yearMonth\": \"\"\n }\n]", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-56d46a31-0cf1-4896-9eb9-9f818a84d492" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-72cc9ada-285f-4032-ad3d-3143af06b946" } ], "id": "433c54f0-9730-437e-b8a5-e528fb6968f6", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-433c54f0-9730-437e-b8a5-e528fb6968f6" } ], "id": "4b808ce1-9b70-4323-bcef-53ac891416de", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-4b808ce1-9b70-4323-bcef-53ac891416de" }, { "name": "Gets a list of finalized past billing history", "id": "fc739861-ca1f-43ec-bbfe-4a4983461a7b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bills", "host": [ "{{baseUrl}}" ], "path": [ "bills" ] }, "description": "Gets a list of finalized past billing history.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "46a1db64-70e2-4426-b8e1-31232cc3815b", "name": "A list of finalized past billing history.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/bills", "host": [ "{{baseUrl}}" ], "path": [ "bills" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"billList\": [\n {\n \"amount\": \"\",\n \"appliedCouponAmount\": \"\",\n \"currency\": \"USD\",\n \"paymentStatus\": \"refund_fail\",\n \"paymentTransactionId\": \"\",\n \"state\": \"temporary\",\n \"yearMonth\": \"\"\n },\n {\n \"amount\": \"\",\n \"appliedCouponAmount\": \"\",\n \"currency\": \"USD\",\n \"paymentStatus\": \"delegating_to_third_party\",\n \"paymentTransactionId\": \"\",\n \"state\": \"temporary\",\n \"yearMonth\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-46a1db64-70e2-4426-b8e1-31232cc3815b" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-fc739861-ca1f-43ec-bbfe-4a4983461a7b" } ], "id": "1dd96c27-c51d-473b-a802-32ea6175e644", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-1dd96c27-c51d-473b-a802-32ea6175e644" }, { "name": "coupons", "item": [ { "name": "{coupon_code}", "item": [ { "name": "register", "item": [ { "name": "Register Coupon", "id": "6b6f3d36-3aa3-4594-a5d3-0e04e6a01ac1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/coupons/:coupon_code/register", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":coupon_code", "register" ], "variable": [ { "id": "4d62e07b-812b-497f-8ec2-c251a45e30da", "key": "coupon_code", "value": "", "description": "(Required) Coupon code." } ] }, "description": "Registers a coupon." }, "response": [ { "id": "c71cf1a9-1cb2-48ad-8b27-d47614abdcc7", "name": "OK.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/coupons/:coupon_code/register", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":coupon_code", "register" ], "variable": [ { "key": "coupon_code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"amount\": \"\",\n \"balance\": \"\",\n \"billItemName\": \"\",\n \"couponCode\": \"\",\n \"currency\": \"EUR\",\n \"expiryYearMonth\": \"\",\n \"orderId\": \"\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-c71cf1a9-1cb2-48ad-8b27-d47614abdcc7" }, { "id": "74039192-0b6f-42f7-b299-cb31f6ad5ca2", "name": "The coupon code is invalid or the coupon code registration limit has been reached.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/coupons/:coupon_code/register", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":coupon_code", "register" ], "variable": [ { "key": "coupon_code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-74039192-0b6f-42f7-b299-cb31f6ad5ca2" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-6b6f3d36-3aa3-4594-a5d3-0e04e6a01ac1" } ], "id": "a5a1ca5d-ef86-493a-b860-261555250597", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-a5a1ca5d-ef86-493a-b860-261555250597" } ], "id": "86925093-7356-46a0-afe5-7e34723ddeae", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-86925093-7356-46a0-afe5-7e34723ddeae" }, { "name": "{order_id}", "item": [ { "name": "confirm", "item": [ { "name": "Confirm coupon order", "id": "1ccc5ce5-3f6e-4fae-a237-8296480e80c7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/coupons/:order_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":order_id", "confirm" ], "variable": [ { "id": "7879d33d-b2f6-4f20-a512-937ae6bdfb20", "key": "order_id", "value": "", "description": "(Required) Order ID. You can get it by calling [Order:createCouponQuotation API](#/Order/createCouponQuotation)." } ] }, "description": "Performs a credit limit and confirms the order if no problems are encountered." }, "response": [ { "id": "f6823930-613c-4271-8a39-a34e32787dfa", "name": "The confirmed coupon order.", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/coupons/:order_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":order_id", "confirm" ], "variable": [ { "key": "order_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"amount\": \"\",\n \"balance\": \"\",\n \"billItemName\": \"\",\n \"couponCode\": \"\",\n \"currency\": \"EUR\",\n \"expiryYearMonth\": \"\",\n \"orderId\": \"\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-f6823930-613c-4271-8a39-a34e32787dfa" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-1ccc5ce5-3f6e-4fae-a237-8296480e80c7" } ], "id": "2da40045-b444-480a-9f5c-61496cfad342", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-2da40045-b444-480a-9f5c-61496cfad342" } ], "id": "53883e5e-db24-4770-8e1a-49861eb64911", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-53883e5e-db24-4770-8e1a-49861eb64911" }, { "name": "List coupons.", "id": "627425e7-e320-41e3-abc9-dd0e945e7766", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/coupons", "host": [ "{{baseUrl}}" ], "path": [ "coupons" ] }, "description": "Returns a list of currently registered coupons." }, "response": [ { "id": "06d51307-819d-4a2a-81dd-c806d9a888ce", "name": "OK.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/coupons", "host": [ "{{baseUrl}}" ], "path": [ "coupons" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"couponList\": [\n {\n \"amount\": \"\",\n \"balance\": \"\",\n \"billItemName\": \"\",\n \"couponCode\": \"\",\n \"currency\": \"USD\",\n \"expiryYearMonth\": \"\",\n \"orderId\": \"\"\n },\n {\n \"amount\": \"\",\n \"balance\": \"\",\n \"billItemName\": \"\",\n \"couponCode\": \"\",\n \"currency\": \"EUR\",\n \"expiryYearMonth\": \"\",\n \"orderId\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-06d51307-819d-4a2a-81dd-c806d9a888ce" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-627425e7-e320-41e3-abc9-dd0e945e7766" }, { "name": "Create coupon quotation", "id": "b78cbd37-ae13-44c5-8f20-227a88548d75", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/coupons", "host": [ "{{baseUrl}}" ], "path": [ "coupons" ] }, "description": "Creates a new coupon quotation. If the orderId is put in /coupons/{order_id}/confirm, the order is complete." }, "response": [ { "id": "39512ce4-c31d-466e-805d-3555660cc3f6", "name": "Created.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/coupons", "host": [ "{{baseUrl}}" ], "path": [ "coupons" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"amount\": \"\",\n \"currency\": \"JPY\",\n \"expiryYearMonth\": \"\",\n \"orderId\": \"\",\n \"taxAmount\": \"\",\n \"totalAmount\": \"\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-39512ce4-c31d-466e-805d-3555660cc3f6" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-b78cbd37-ae13-44c5-8f20-227a88548d75" } ], "id": "4a2f616c-8c77-4b00-b15e-9d58a332debd", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-4a2f616c-8c77-4b00-b15e-9d58a332debd" }, { "name": "payment_history", "item": [ { "name": "transactions", "item": [ { "name": "{payment_transaction_id}", "item": [ { "name": "Get payment transaction result.", "id": "8743dd1f-c866-4eb6-b662-74308282772d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payment_history/transactions/:payment_transaction_id", "host": [ "{{baseUrl}}" ], "path": [ "payment_history", "transactions", ":payment_transaction_id" ], "variable": [ { "id": "90013d9d-e634-4dd3-9013-e03979b266e3", "key": "payment_transaction_id", "value": "", "description": "(Required) Payment transaction ID. It can be obtained via [Billing:getBillingHistory API](#!/Billing/getBillingHistory) or [Billing:getBilling API](#!/Billing/getBilling)." } ] }, "description": "Returns result of a payment transaction.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "b8350f60-2621-4d8e-829a-649d7792620a", "name": "OK.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_history/transactions/:payment_transaction_id", "host": [ "{{baseUrl}}" ], "path": [ "payment_history", "transactions", ":payment_transaction_id" ], "variable": [ { "key": "payment_transaction_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"amount\": {\n \"currency\": \"USD\",\n \"paymentAmount\": \"\",\n \"subTotalAmount\": \"\",\n \"taxAmount\": \"\",\n \"taxFreeSubTotalAmount\": \"\",\n \"taxRate\": {},\n \"taxableSubTotalAmount\": \"\",\n \"totalAmount\": \"\",\n \"withholdingTaxAmount\": \"\"\n },\n \"description\": {\n \"description\": \"\",\n \"itemList\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\",\n \"messageCode\": \"invalid_number\",\n \"status\": \"error\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-b8350f60-2621-4d8e-829a-649d7792620a" }, { "id": "aec94407-cc47-4927-a48d-92209e747919", "name": "Invalid payment transaction ID.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_history/transactions/:payment_transaction_id", "host": [ "{{baseUrl}}" ], "path": [ "payment_history", "transactions", ":payment_transaction_id" ], "variable": [ { "key": "payment_transaction_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-aec94407-cc47-4927-a48d-92209e747919" }, { "id": "5f4dead1-88fc-455f-ba78-15f953d31908", "name": "Payment transaction result not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_history/transactions/:payment_transaction_id", "host": [ "{{baseUrl}}" ], "path": [ "payment_history", "transactions", ":payment_transaction_id" ], "variable": [ { "key": "payment_transaction_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-5f4dead1-88fc-455f-ba78-15f953d31908" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-8743dd1f-c866-4eb6-b662-74308282772d" } ], "id": "14122988-d407-44d5-a0e4-70a0750e506f", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-14122988-d407-44d5-a0e4-70a0750e506f" } ], "id": "04852631-8def-4518-b00d-88dea360864d", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-04852631-8def-4518-b00d-88dea360864d" } ], "id": "fa9f9f1f-ef7d-4197-91d6-744299a320ee", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-fa9f9f1f-ef7d-4197-91d6-744299a320ee" }, { "name": "payment_methods", "item": [ { "name": "current", "item": [ { "name": "activate", "item": [ { "name": "Activate current payment method", "id": "b253ee2b-c243-4b19-b431-15b4fdaef146", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payment_methods/current/activate", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "current", "activate" ] }, "description": "Activates a current payment method that has an error." }, "response": [ { "id": "62adfa9e-8c20-47ee-b8ec-f9ccd48e16df", "name": "OK.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_methods/current/activate", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "current", "activate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-62adfa9e-8c20-47ee-b8ec-f9ccd48e16df" }, { "id": "d9c54286-ac43-48f8-820d-a58a22e5d9c1", "name": "Payment method not found.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_methods/current/activate", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "current", "activate" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-d9c54286-ac43-48f8-820d-a58a22e5d9c1" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-b253ee2b-c243-4b19-b431-15b4fdaef146" } ], "id": "103bcc5e-18ae-44ee-a2aa-2a5f910503cc", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-103bcc5e-18ae-44ee-a2aa-2a5f910503cc" }, { "name": "Get current payment method information.", "id": "8b8ede5e-585f-416c-9366-5a559f81bebc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payment_methods/current", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "current" ] }, "description": "Returns current payment methods. Detailed information is included in the properties." }, "response": [ { "id": "f107a5f9-0ff5-4df9-9868-0bbae567025e", "name": "OK.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_methods/current", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "current" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"invalid_cvc\",\n \"errorMessage\": \"\",\n \"properties\": \"\",\n \"providerType\": \"WebPay\",\n \"updateDate\": \"\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-f107a5f9-0ff5-4df9-9868-0bbae567025e" }, { "id": "88ecbddf-f915-49d7-b4d0-d45b98855e47", "name": "Payment method not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_methods/current", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", "current" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-88ecbddf-f915-49d7-b4d0-d45b98855e47" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-8b8ede5e-585f-416c-9366-5a559f81bebc" } ], "id": "90720ea6-6755-441a-bdc8-2578d1d6634a", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-90720ea6-6755-441a-bdc8-2578d1d6634a" } ], "id": "ebea3a9a-fa1b-4bc1-9117-45941a1856ce", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-ebea3a9a-fa1b-4bc1-9117-45941a1856ce" }, { "name": "payment_statements", "item": [ { "name": "{payment_statement_id}", "item": [ { "name": "export", "item": [ { "name": "Export payment statement", "id": "6f96f440-b91f-421c-a59c-e40ece67ba4b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payment_statements/:payment_statement_id/export?export_mode=async", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements", ":payment_statement_id", "export" ], "query": [ { "description": "Export mode (async, sync)", "key": "export_mode", "value": "async" } ], "variable": [ { "id": "50e3d1fc-65cc-4c0d-a13b-0e8fbe587d7e", "key": "payment_statement_id", "value": "", "description": "(Required) Payment statement ID" } ] }, "description": "Export payment statement.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "a5e377ee-e17c-442f-9e3e-1336ced72895", "name": "OK.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_statements/:payment_statement_id/export?export_mode=async", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements", ":payment_statement_id", "export" ], "query": [ { "description": "Export mode (async, sync)", "key": "export_mode", "value": "async" } ], "variable": [ { "key": "payment_statement_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"exportedFileId\": \"\",\n \"exportedFilePath\": \"\",\n \"url\": \"\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-a5e377ee-e17c-442f-9e3e-1336ced72895" }, { "id": "7c666a02-0f3c-4a3a-a38a-7c1d9ed0132a", "name": "Invalid payment statement ID.", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_statements/:payment_statement_id/export?export_mode=async", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements", ":payment_statement_id", "export" ], "query": [ { "description": "Export mode (async, sync)", "key": "export_mode", "value": "async" } ], "variable": [ { "key": "payment_statement_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-7c666a02-0f3c-4a3a-a38a-7c1d9ed0132a" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-6f96f440-b91f-421c-a59c-e40ece67ba4b" } ], "id": "c8794df7-bdfd-49e3-90e3-ba68ec75e6a9", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-c8794df7-bdfd-49e3-90e3-ba68ec75e6a9" } ], "id": "202f61a8-912f-4e18-a8df-096edb5ca0d3", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-202f61a8-912f-4e18-a8df-096edb5ca0d3" }, { "name": "payer_information", "item": [ { "name": "Export payer information", "id": "e8cf3919-03fd-4718-874a-10dfde1a5331", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payment_statements/payer_information", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements", "payer_information" ] }, "description": "Export payer information." }, "response": [ { "id": "fcf1be27-a7eb-4bc8-9e9a-40e67aa01c7b", "name": "OK.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_statements/payer_information", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements", "payer_information" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"companyName\": \"\",\n \"department\": \"\",\n \"fullName\": \"\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-fcf1be27-a7eb-4bc8-9e9a-40e67aa01c7b" }, { "id": "e997a69c-9e90-49ec-877d-955f78ccc314", "name": "Payer information not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_statements/payer_information", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements", "payer_information" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-e997a69c-9e90-49ec-877d-955f78ccc314" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-e8cf3919-03fd-4718-874a-10dfde1a5331" }, { "name": "Register payer information", "id": "d99948bd-b59b-45a1-9352-c8cdeb228279", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"companyName\": \"\",\n \"department\": \"\",\n \"fullName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_statements/payer_information", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements", "payer_information" ] }, "description": "Register payer information." }, "response": [ { "id": "28a0a272-4b93-457d-803c-f597b10e014e", "name": "Created.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"companyName\": \"\",\n \"department\": \"\",\n \"fullName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_statements/payer_information", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements", "payer_information" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-28a0a272-4b93-457d-803c-f597b10e014e" }, { "id": "dfa3bbe6-b6e5-42f8-9892-cb5ec8e51506", "name": "Invalid payer information.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"companyName\": \"\",\n \"department\": \"\",\n \"fullName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_statements/payer_information", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements", "payer_information" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-dfa3bbe6-b6e5-42f8-9892-cb5ec8e51506" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-d99948bd-b59b-45a1-9352-c8cdeb228279" } ], "id": "69dcfeac-11a1-4ae2-adb1-12fc0b118864", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-69dcfeac-11a1-4ae2-adb1-12fc0b118864" }, { "name": "List payment statements", "id": "3f6bea7f-20d5-45a2-9005-e47a6eea7684", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payment_statements", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements" ] }, "description": "List payment statements.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "186daa98-1dd5-477f-bb21-504cb3c0b2fb", "name": "OK.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_statements", "host": [ "{{baseUrl}}" ], "path": [ "payment_statements" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"paymentStatementsList\": [\n {\n \"amount\": \"\",\n \"chargedYearMonths\": [\n \"\",\n \"\"\n ],\n \"currency\": \"EUR\",\n \"orderId\": \"\",\n \"paymentDateTime\": \"\",\n \"paymentInstrument\": \"\",\n \"paymentMethod\": \"\",\n \"paymentStatementId\": \"\",\n \"paymentStatementInfo\": \"\"\n },\n {\n \"amount\": \"\",\n \"chargedYearMonths\": [\n \"\",\n \"\"\n ],\n \"currency\": \"JPY\",\n \"orderId\": \"\",\n \"paymentDateTime\": \"\",\n \"paymentInstrument\": \"\",\n \"paymentMethod\": \"\",\n \"paymentStatementId\": \"\",\n \"paymentStatementInfo\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-186daa98-1dd5-477f-bb21-504cb3c0b2fb" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-3f6bea7f-20d5-45a2-9005-e47a6eea7684" } ], "id": "a5b66170-7c06-4811-9e98-22bf25806e16", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-a5b66170-7c06-4811-9e98-22bf25806e16" }, { "name": "volume_discounts", "item": [ { "name": "{contract_id}", "item": [ { "name": "Get long term discount", "id": "55a09a42-ecff-42ea-9316-594a0ae5fb25", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/volume_discounts/:contract_id", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts", ":contract_id" ], "variable": [ { "id": "80a7a41b-91dd-475b-853e-032ffe49f4ce", "key": "contract_id", "value": "", "description": "(Required) Contract ID." } ] }, "description": "Returns contracted long term discount.\n\n**Warning**: Information can be obtained up to 18 months in the past or 6 months after the contract ends. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "7579bc4b-f49b-4970-b989-138378a57e40", "name": "OK.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/volume_discounts/:contract_id", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts", ":contract_id" ], "variable": [ { "key": "contract_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"contractDateTime\": \"\",\n \"contractId\": \"\",\n \"contractTermMonth\": 12,\n \"currency\": \"JPY\",\n \"endDate\": \"\",\n \"initialCost\": \"\",\n \"quantity\": \"\",\n \"startDate\": \"\",\n \"status\": \"expired\",\n \"unitPrice\": \"\",\n \"volumeDiscountPaymentType\": \"MONTHLY\",\n \"volumeDiscountType\": \"SORACOM_AIR_MONTHLY_FIXED_BASIC_CHARGE\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-7579bc4b-f49b-4970-b989-138378a57e40" }, { "id": "498c2b6e-95ca-43c4-a612-6f57219c0616", "name": "Long term discount not found.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/volume_discounts/:contract_id", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts", ":contract_id" ], "variable": [ { "key": "contract_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-498c2b6e-95ca-43c4-a612-6f57219c0616" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-55a09a42-ecff-42ea-9316-594a0ae5fb25" } ], "id": "56b14e32-a068-4a5c-8535-44348679c7b6", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-56b14e32-a068-4a5c-8535-44348679c7b6" }, { "name": "{order_id}", "item": [ { "name": "confirm", "item": [ { "name": "Confirm long-term discount order", "id": "8b74ac0d-3244-41a5-a676-005deb319802", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/volume_discounts/:order_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts", ":order_id", "confirm" ], "variable": [ { "id": "6d8e5b19-5a90-42d1-abf1-221ed6392c1c", "key": "order_id", "value": "", "description": "(Required) Order ID. The order ID can be obtained from the [Order:createVolumeDiscountQuotation API](#/Order/createVolumeDiscountQuotation)." } ] }, "description": "Performs a credit check and confirms the order if there are no issues." }, "response": [ { "id": "e928cc06-7220-428f-93f3-7447e1f75242", "name": "The confirmed long-term discount order.", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/volume_discounts/:order_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts", ":order_id", "confirm" ], "variable": [ { "key": "order_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"contractDateTime\": \"\",\n \"contractId\": \"\",\n \"contractTermMonth\": 12,\n \"currency\": \"JPY\",\n \"endDate\": \"\",\n \"initialCost\": \"\",\n \"quantity\": \"\",\n \"startDate\": \"\",\n \"status\": \"expired\",\n \"unitPrice\": \"\",\n \"volumeDiscountPaymentType\": \"MONTHLY\",\n \"volumeDiscountType\": \"SORACOM_AIR_MONTHLY_FIXED_BASIC_CHARGE\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-e928cc06-7220-428f-93f3-7447e1f75242" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-8b74ac0d-3244-41a5-a676-005deb319802" } ], "id": "a3bbc5a5-7dfd-4e91-8549-bbcb9d0e0123", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-a3bbc5a5-7dfd-4e91-8549-bbcb9d0e0123" } ], "id": "bea689be-6af0-4701-9928-94779ddaddfe", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-bea689be-6af0-4701-9928-94779ddaddfe" }, { "name": "available_discounts", "item": [ { "name": "List available long term discounts", "id": "667577c5-137b-460d-921d-004de3759c5a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/volume_discounts/available_discounts", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts", "available_discounts" ] }, "description": "Returns a list of available long term discounts." }, "response": [ { "id": "3980c399-4833-4f42-9a89-a653024e3c7a", "name": "A list of available long term discounts.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/volume_discounts/available_discounts", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts", "available_discounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"availableLongTermDiscounts\": [\n {\n \"contractTermMonth\": 12,\n \"currency\": \"JPY\",\n \"taxIncludedUnitPrice\": \"\",\n \"unitPrice\": \"\",\n \"volumeDiscountPaymentType\": \"PREPAYMENT\",\n \"volumeDiscountType\": \"SORACOM_AIR_BASIC_CHARGE_V2\"\n },\n {\n \"contractTermMonth\": 12,\n \"currency\": \"USD\",\n \"taxIncludedUnitPrice\": \"\",\n \"unitPrice\": \"\",\n \"volumeDiscountPaymentType\": \"PREPAYMENT\",\n \"volumeDiscountType\": \"SORACOM_AIR_BASIC_CHARGE_V2\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-3980c399-4833-4f42-9a89-a653024e3c7a" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-667577c5-137b-460d-921d-004de3759c5a" } ], "id": "6094f947-0ba2-4388-aa9a-ffe8580a37fe", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-6094f947-0ba2-4388-aa9a-ffe8580a37fe" }, { "name": "List long term discounts", "id": "f8ce480c-bdc5-4e60-841d-3b0b281ea855", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/volume_discounts", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts" ] }, "description": "Returns a list of contracted long term discounts.\n\n**Warning**: Information can be obtained up to 18 months in the past or 6 months after the contract ends. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "cbe8197d-5021-4d99-8e84-25ad4303e3ac", "name": "OK.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/volume_discounts", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"volumeDiscountList\": [\n {\n \"contractDateTime\": \"\",\n \"contractId\": \"\",\n \"contractTermMonth\": 12,\n \"currency\": \"JPY\",\n \"endDate\": \"\",\n \"initialCost\": \"\",\n \"quantity\": \"\",\n \"startDate\": \"\",\n \"status\": \"active\",\n \"unitPrice\": \"\",\n \"volumeDiscountPaymentType\": \"PREPAYMENT\",\n \"volumeDiscountType\": \"SORACOM_AIR_MONTHLY_FIXED_BASIC_CHARGE\"\n },\n {\n \"contractDateTime\": \"\",\n \"contractId\": \"\",\n \"contractTermMonth\": 12,\n \"currency\": \"EUR\",\n \"endDate\": \"\",\n \"initialCost\": \"\",\n \"quantity\": \"\",\n \"startDate\": \"\",\n \"status\": \"active\",\n \"unitPrice\": \"\",\n \"volumeDiscountPaymentType\": \"PREPAYMENT\",\n \"volumeDiscountType\": \"SORACOM_AIR_BASIC_CHARGE_V2\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-cbe8197d-5021-4d99-8e84-25ad4303e3ac" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-f8ce480c-bdc5-4e60-841d-3b0b281ea855" }, { "name": "Create long term discount quotation", "id": "564860fe-69ea-4785-924b-b83efa11c7f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"volumeDiscountType\": \"SORACOM_AIR_BASIC_CHARGE\",\n \"volumeDiscountPaymentType\": \"PREPAYMENT\",\n \"contractTermMonth\": 12,\n \"quantity\": \"\",\n \"startDate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/volume_discounts", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts" ] }, "description": "Creates a new long term discount quotation. If the orderId is put in /volume_discounts/{order_id}/confirm, the order is complete (Currently, long term discount is only applied to plan-D (without bundle), plan-K)." }, "response": [ { "id": "a8e49bc7-1d3f-4f95-9aba-698249cf5272", "name": "Created.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"volumeDiscountType\": \"SORACOM_AIR_BASIC_CHARGE\",\n \"volumeDiscountPaymentType\": \"PREPAYMENT\",\n \"contractTermMonth\": 12,\n \"quantity\": \"\",\n \"startDate\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/volume_discounts", "host": [ "{{baseUrl}}" ], "path": [ "volume_discounts" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"currency\": \"JPY\",\n \"orderId\": \"\",\n \"taxAmount\": \"\",\n \"totalAmount\": \"\",\n \"volumeDiscount\": {\n \"contractTermMonth\": 12,\n \"currency\": \"USD\",\n \"endDate\": \"\",\n \"initialCost\": \"\",\n \"quantity\": \"\",\n \"startDate\": \"\",\n \"taxIncludedInitialCost\": \"\",\n \"taxIncludedUnitPrice\": \"\",\n \"unitPrice\": \"\",\n \"volumeDiscountPaymentType\": \"PREPAYMENT\",\n \"volumeDiscountType\": \"SORACOM_AIR_MONTHLY_FIXED_BASIC_CHARGE\"\n }\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-a8e49bc7-1d3f-4f95-9aba-698249cf5272" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-564860fe-69ea-4785-924b-b83efa11c7f7" } ], "id": "7776359d-3277-4cf6-9ed5-0df24b699fb2", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-7776359d-3277-4cf6-9ed5-0df24b699fb2" }, { "name": "orders", "item": [ { "name": "{order_id}", "item": [ { "name": "cancel", "item": [ { "name": "Cancel order", "id": "6e0ed3c2-639e-472c-b7af-73403eb43544", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/orders/:order_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "cancel" ], "variable": [ { "id": "1f23349c-d00c-4bd7-bdff-79d2b36bb3eb", "key": "order_id", "value": "", "description": "(Required) Order ID. You can get it by calling [Order:listOrders API](#/Order/listOrders)." } ] }, "description": "Cancels an order. If the order has already been dispatched, an error is returned." }, "response": [ { "id": "fb45e300-6ec7-4b22-abe0-8b1f9502e1d3", "name": "The order was cancelled.", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/orders/:order_id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "cancel" ], "variable": [ { "key": "order_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-fb45e300-6ec7-4b22-abe0-8b1f9502e1d3" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-6e0ed3c2-639e-472c-b7af-73403eb43544" } ], "id": "80525f7f-3d5e-41bb-a856-7f1a1ae7e0d2", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-80525f7f-3d5e-41bb-a856-7f1a1ae7e0d2" }, { "name": "confirm", "item": [ { "name": "Confirm order", "id": "e0e81ed8-9465-4bc4-a0a1-fa71600208fb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/orders/:order_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "confirm" ], "variable": [ { "id": "0ac9ef44-c99c-4680-8dcd-cfc2993da934", "key": "order_id", "value": "", "description": "(Required) Order ID. You can get it by calling [Order:listOrders API](#/Order/listOrders)." } ] }, "description": "Performs a credit limit and confirms the order if no problems are encountered.\n\n**Warning**: Only orders completed within the past month can be confirmed. If one month has elapsed, please redo the order placement operation.\n" }, "response": [ { "id": "e7929ab0-1cd0-4931-af8d-c4896055e0d3", "name": "The confirmed order information.", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/orders/:order_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "confirm" ], "variable": [ { "key": "order_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"balanceDue\": \"\",\n \"containsTaxIncludedAmounts\": \"\",\n \"currency\": \"JPY\",\n \"email\": \"\",\n \"orderChannel\": \"\",\n \"orderDateTime\": \"\",\n \"orderId\": \"\",\n \"orderItemList\": [\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"JPY\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"lora\",\n \"properties\": {\n \"sunt_97f\": \"\",\n \"amet__4\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n },\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"USD\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"lora\",\n \"properties\": {\n \"fugiat_f1_\": \"\",\n \"id0\": \"\",\n \"et_19\": \"\",\n \"sit8c\": \"\",\n \"deserunt_\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n }\n ],\n \"orderStatus\": \"shipped\",\n \"paymentStatus\": \"delegated_to_third_party\",\n \"preferredDeliveryDate\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"resourceInitialSetting\": {\n \"simInitialSettings\": {\n \"sunt7\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"consectetur_6\": \"\",\n \"esse_7\": \"\",\n \"aute__b_\": \"\"\n }\n },\n \"nostrud_ed2\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"ad_0\": \"\",\n \"deserunt_880\": \"\",\n \"ullamco_c\": \"\"\n }\n },\n \"dolor_8f\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"quis4e8\": \"\"\n }\n }\n }\n },\n \"shippingAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n },\n \"shippingAddressId\": \"\",\n \"shippingCost\": \"\",\n \"shippingDateTime\": \"\",\n \"shippingLabelDetails\": [\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n },\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n }\n ],\n \"shippingLabelNumber\": \"\",\n \"shippingLabelNumbers\": [\n \"\",\n \"\"\n ],\n \"taxAmount\": \"\",\n \"taxIncludedInShippingCost\": \"\",\n \"taxOnShippingCost\": \"\",\n \"totalAmount\": \"\",\n \"withholdingTaxAmount\": \"\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-e7929ab0-1cd0-4931-af8d-c4896055e0d3" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-e0e81ed8-9465-4bc4-a0a1-fa71600208fb" } ], "id": "5985b90d-380b-4fcb-b162-cc8456ed64e6", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-5985b90d-380b-4fcb-b162-cc8456ed64e6" }, { "name": "resource_initial_setting", "item": [ { "name": "Update resource initial setting for an order", "id": "3720a809-5cd7-493f-a1ac-169fb7616427", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"simInitialSettings\": {\n \"animf4\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"qui50\": \"\",\n \"nostrud_b_\": \"\",\n \"ut__8\": \"\",\n \"irureb\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/orders/:order_id/resource_initial_setting", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "resource_initial_setting" ], "variable": [ { "id": "c685b35b-8f93-4d59-8fbc-944bceb925ae", "key": "order_id", "value": "", "description": "(Required) Order ID. You can get it by calling [Order:listOrders API](#/Order/listOrders)." } ] }, "description": "Update resource initial setting for an order.\n\n**Warning**: Initial settings of IoT SIM cannot be specified after confirmation of receipt.\n" }, "response": [ { "id": "1f057617-abcb-4806-86bc-639ee8517024", "name": "The initial setting has been successfully updated.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"simInitialSettings\": {\n \"animf4\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"qui50\": \"\",\n \"nostrud_b_\": \"\",\n \"ut__8\": \"\",\n \"irureb\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/orders/:order_id/resource_initial_setting", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "resource_initial_setting" ], "variable": [ { "key": "order_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"balanceDue\": \"\",\n \"containsTaxIncludedAmounts\": \"\",\n \"currency\": \"JPY\",\n \"email\": \"\",\n \"orderChannel\": \"\",\n \"orderDateTime\": \"\",\n \"orderId\": \"\",\n \"orderItemList\": [\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"JPY\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"lora\",\n \"properties\": {\n \"sunt_97f\": \"\",\n \"amet__4\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n },\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"USD\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"lora\",\n \"properties\": {\n \"fugiat_f1_\": \"\",\n \"id0\": \"\",\n \"et_19\": \"\",\n \"sit8c\": \"\",\n \"deserunt_\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n }\n ],\n \"orderStatus\": \"shipped\",\n \"paymentStatus\": \"delegated_to_third_party\",\n \"preferredDeliveryDate\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"resourceInitialSetting\": {\n \"simInitialSettings\": {\n \"sunt7\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"consectetur_6\": \"\",\n \"esse_7\": \"\",\n \"aute__b_\": \"\"\n }\n },\n \"nostrud_ed2\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"ad_0\": \"\",\n \"deserunt_880\": \"\",\n \"ullamco_c\": \"\"\n }\n },\n \"dolor_8f\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"quis4e8\": \"\"\n }\n }\n }\n },\n \"shippingAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n },\n \"shippingAddressId\": \"\",\n \"shippingCost\": \"\",\n \"shippingDateTime\": \"\",\n \"shippingLabelDetails\": [\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n },\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n }\n ],\n \"shippingLabelNumber\": \"\",\n \"shippingLabelNumbers\": [\n \"\",\n \"\"\n ],\n \"taxAmount\": \"\",\n \"taxIncludedInShippingCost\": \"\",\n \"taxOnShippingCost\": \"\",\n \"totalAmount\": \"\",\n \"withholdingTaxAmount\": \"\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-1f057617-abcb-4806-86bc-639ee8517024" }, { "id": "719d4e5c-7b72-45e6-bf58-a6f7455cbd9c", "name": "The specified request has a problem.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"simInitialSettings\": {\n \"animf4\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"qui50\": \"\",\n \"nostrud_b_\": \"\",\n \"ut__8\": \"\",\n \"irureb\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/orders/:order_id/resource_initial_setting", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "resource_initial_setting" ], "variable": [ { "key": "order_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-719d4e5c-7b72-45e6-bf58-a6f7455cbd9c" }, { "id": "654716ab-43d9-4eec-8333-3dd1f43cccf3", "name": "Order ID not found.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"simInitialSettings\": {\n \"animf4\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"qui50\": \"\",\n \"nostrud_b_\": \"\",\n \"ut__8\": \"\",\n \"irureb\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/orders/:order_id/resource_initial_setting", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "resource_initial_setting" ], "variable": [ { "key": "order_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-654716ab-43d9-4eec-8333-3dd1f43cccf3" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-3720a809-5cd7-493f-a1ac-169fb7616427" } ], "id": "64946fc0-f3b3-4b80-b354-c9d1ea85f297", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-64946fc0-f3b3-4b80-b354-c9d1ea85f297" }, { "name": "subscribers", "item": [ { "name": "register", "item": [ { "name": "Register subscribers for operator", "id": "9cc74670-24a4-4897-b568-b198cf9565a2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/orders/:order_id/subscribers/register", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "subscribers", "register" ], "variable": [ { "id": "324fa6ce-a4f7-484e-8d6c-839c83588b3e", "key": "order_id", "value": "", "description": "(Required) Order ID. You can get it by calling [Order:listOrders API](#/Order/listOrders)." } ] }, "description": "Registers the ordered SIM with the operator.\n\n**Warning**: IoT SIMs can only be registered for the past 18 months. If you need to register an IoT SIM that was ordered before the time period, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "02707ef6-9c8b-4dce-addb-ece8e3f0f154", "name": "Subscribers were registered for the operator.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/orders/:order_id/subscribers/register", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "subscribers", "register" ], "variable": [ { "key": "order_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-02707ef6-9c8b-4dce-addb-ece8e3f0f154" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-9cc74670-24a4-4897-b568-b198cf9565a2" } ], "id": "55ad5026-3e78-40f6-9b80-98e36a603835", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-55ad5026-3e78-40f6-9b80-98e36a603835" }, { "name": "List ordered subscribers", "id": "952dc898-aa0c-4e95-bc04-28a42ef46086", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/orders/:order_id/subscribers?last_evaluated_key=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "subscribers" ], "query": [ { "description": "The value of the `x-soracom-next-key` header returned when the previous page was retrieved. Specify if the next page is to be retrieved. For details, see [Handling Pagination](/en/docs/tools/api-reference/#handling-pagination).", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of subscribers in a response.", "key": "limit", "value": "" } ], "variable": [ { "id": "7b32b28e-fae7-4765-aad1-0426f999db5d", "key": "order_id", "value": "", "description": "(Required) Order ID. You can get it by calling [Order:listOrders API](#/Order/listOrders)." } ] }, "description": "List ordered subscribers.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "70c7081d-934c-48de-846e-5e9152960283", "name": "A list of ordered subscribers.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/orders/:order_id/subscribers?last_evaluated_key=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id", "subscribers" ], "query": [ { "description": "The value of the `x-soracom-next-key` header returned when the previous page was retrieved. Specify if the next page is to be retrieved. For details, see [Handling Pagination](/en/docs/tools/api-reference/#handling-pagination).", "key": "last_evaluated_key", "value": "" }, { "description": "Maximum number of subscribers in a response.", "key": "limit", "value": "" } ], "variable": [ { "key": "order_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"orderedSubscriberList\": [\n {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"deviceSerialNumber\": \"\",\n \"eiccid\": \"\",\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"serialNumber\": \"\",\n \"simId\": \"\"\n },\n {\n \"bundles\": [\n \"\",\n \"\"\n ],\n \"deviceSerialNumber\": \"\",\n \"eiccid\": \"\",\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"msisdn\": \"\",\n \"serialNumber\": \"\",\n \"simId\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-70c7081d-934c-48de-846e-5e9152960283" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-952dc898-aa0c-4e95-bc04-28a42ef46086" } ], "id": "ca079c15-3ebd-45eb-b069-25aed6c3a0a6", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-ca079c15-3ebd-45eb-b069-25aed6c3a0a6" }, { "name": "Get a confirmed order", "id": "b9b5ea91-1e42-4cc9-b9cb-e0fa5f4ac025", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/orders/:order_id", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id" ], "variable": [ { "id": "59d9bca4-8b38-4495-8d5c-516cef734103", "key": "order_id", "value": "", "description": "(Required) Order ID. You can get it by calling [Order:listOrders API](#/Order/listOrders)." } ] }, "description": "Returns a confirmed order.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "5352e3b8-6939-41b5-860b-77fa96c6aad6", "name": "The confirmed order information.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/orders/:order_id", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":order_id" ], "variable": [ { "key": "order_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"balanceDue\": \"\",\n \"containsTaxIncludedAmounts\": \"\",\n \"currency\": \"JPY\",\n \"email\": \"\",\n \"orderChannel\": \"\",\n \"orderDateTime\": \"\",\n \"orderId\": \"\",\n \"orderItemList\": [\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"JPY\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"lora\",\n \"properties\": {\n \"sunt_97f\": \"\",\n \"amet__4\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n },\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"USD\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"lora\",\n \"properties\": {\n \"fugiat_f1_\": \"\",\n \"id0\": \"\",\n \"et_19\": \"\",\n \"sit8c\": \"\",\n \"deserunt_\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n }\n ],\n \"orderStatus\": \"shipped\",\n \"paymentStatus\": \"delegated_to_third_party\",\n \"preferredDeliveryDate\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"resourceInitialSetting\": {\n \"simInitialSettings\": {\n \"sunt7\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"consectetur_6\": \"\",\n \"esse_7\": \"\",\n \"aute__b_\": \"\"\n }\n },\n \"nostrud_ed2\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"ad_0\": \"\",\n \"deserunt_880\": \"\",\n \"ullamco_c\": \"\"\n }\n },\n \"dolor_8f\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"quis4e8\": \"\"\n }\n }\n }\n },\n \"shippingAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n },\n \"shippingAddressId\": \"\",\n \"shippingCost\": \"\",\n \"shippingDateTime\": \"\",\n \"shippingLabelDetails\": [\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n },\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n }\n ],\n \"shippingLabelNumber\": \"\",\n \"shippingLabelNumbers\": [\n \"\",\n \"\"\n ],\n \"taxAmount\": \"\",\n \"taxIncludedInShippingCost\": \"\",\n \"taxOnShippingCost\": \"\",\n \"totalAmount\": \"\",\n \"withholdingTaxAmount\": \"\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-5352e3b8-6939-41b5-860b-77fa96c6aad6" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-b9b5ea91-1e42-4cc9-b9cb-e0fa5f4ac025" } ], "id": "85e6efd1-a8b2-4dda-a312-561afccefdbc", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-85e6efd1-a8b2-4dda-a312-561afccefdbc" }, { "name": "Get a list of confirmed order history", "id": "197d52ad-3b50-447d-bcbe-bae285b1d34e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ] }, "description": "Get a list of confirmed order history.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, "response": [ { "id": "3501d004-2b52-4fd1-a504-f5ce917f26ab", "name": "A list of confirmed order history.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"orderList\": [\n {\n \"balanceDue\": \"\",\n \"containsTaxIncludedAmounts\": \"\",\n \"currency\": \"USD\",\n \"email\": \"\",\n \"orderChannel\": \"\",\n \"orderDateTime\": \"\",\n \"orderId\": \"\",\n \"orderItemList\": [\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"USD\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"sim\",\n \"properties\": {\n \"culpa1\": \"\",\n \"in_79\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n },\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"USD\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"sim\",\n \"properties\": {\n \"eiusmod_f0\": \"\",\n \"laboris_8\": \"\",\n \"in_a12\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n }\n ],\n \"orderStatus\": \"receiving\",\n \"paymentStatus\": \"paid\",\n \"preferredDeliveryDate\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"resourceInitialSetting\": {\n \"simInitialSettings\": {\n \"in_3\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"dolore_d\": \"\",\n \"etc\": \"\"\n }\n },\n \"dolor_59\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"sitc_d\": \"\"\n }\n }\n }\n },\n \"shippingAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n },\n \"shippingAddressId\": \"\",\n \"shippingCost\": \"\",\n \"shippingDateTime\": \"\",\n \"shippingLabelDetails\": [\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n },\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n }\n ],\n \"shippingLabelNumber\": \"\",\n \"shippingLabelNumbers\": [\n \"\",\n \"\"\n ],\n \"taxAmount\": \"\",\n \"taxIncludedInShippingCost\": \"\",\n \"taxOnShippingCost\": \"\",\n \"totalAmount\": \"\",\n \"withholdingTaxAmount\": \"\"\n },\n {\n \"balanceDue\": \"\",\n \"containsTaxIncludedAmounts\": \"\",\n \"currency\": \"USD\",\n \"email\": \"\",\n \"orderChannel\": \"\",\n \"orderDateTime\": \"\",\n \"orderId\": \"\",\n \"orderItemList\": [\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"USD\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"sim\",\n \"properties\": {\n \"eu_2\": \"\",\n \"aliqua93\": \"\",\n \"dolorfd8\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n },\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"JPY\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"lora\",\n \"properties\": {\n \"aliquip_a\": \"\",\n \"amet808\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n }\n ],\n \"orderStatus\": \"cancelling\",\n \"paymentStatus\": \"delegating_to_third_party\",\n \"preferredDeliveryDate\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"resourceInitialSetting\": {\n \"simInitialSettings\": {\n \"irure_ade\": {\n \"groupId\": \"\",\n \"speedClass\": \"\",\n \"tags\": {\n \"nisi_91\": \"\"\n }\n }\n }\n },\n \"shippingAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n },\n \"shippingAddressId\": \"\",\n \"shippingCost\": \"\",\n \"shippingDateTime\": \"\",\n \"shippingLabelDetails\": [\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n },\n {\n \"shipmentCompany\": \"\",\n \"trackingNumber\": \"\",\n \"shipmentCompanyUrl\": \"\",\n \"trackingUrl\": \"\"\n }\n ],\n \"shippingLabelNumber\": \"\",\n \"shippingLabelNumbers\": [\n \"\",\n \"\"\n ],\n \"taxAmount\": \"\",\n \"taxIncludedInShippingCost\": \"\",\n \"taxOnShippingCost\": \"\",\n \"totalAmount\": \"\",\n \"withholdingTaxAmount\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-3501d004-2b52-4fd1-a504-f5ce917f26ab" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-197d52ad-3b50-447d-bcbe-bae285b1d34e" }, { "name": "Create Quotation", "id": "f5216ad8-dc80-4e0f-8692-f6204caa44ba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"orderItemList\": [\n {\n \"productCode\": \"\",\n \"quantity\": \"\"\n },\n {\n \"productCode\": \"\",\n \"quantity\": \"\"\n }\n ],\n \"preferredDeliveryDate\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingOptions\": [\n {\n \"allowNekopos\": \"\",\n \"shipmentCompany\": \"yamato_transport\"\n },\n {\n \"allowNekopos\": \"\",\n \"shipmentCompany\": \"yamato_transport\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ] }, "description": "Creates a new order quotation. If the orderId is put in /orders/{order_id}/confirm, the order is complete." }, "response": [ { "id": "c64d7fe7-99c8-45d9-bb92-766a938c0ac0", "name": "A new order quotation was created.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"orderItemList\": [\n {\n \"productCode\": \"\",\n \"quantity\": \"\"\n },\n {\n \"productCode\": \"\",\n \"quantity\": \"\"\n }\n ],\n \"preferredDeliveryDate\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingOptions\": [\n {\n \"allowNekopos\": \"\",\n \"shipmentCompany\": \"yamato_transport\"\n },\n {\n \"allowNekopos\": \"\",\n \"shipmentCompany\": \"yamato_transport\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"appliedShippingOptions\": [\n {\n \"allowNekopos\": \"\",\n \"shipmentCompany\": \"yamato_transport\"\n },\n {\n \"allowNekopos\": \"\",\n \"shipmentCompany\": \"yamato_transport\"\n }\n ],\n \"balanceDue\": \"\",\n \"containsTaxIncludedAmounts\": \"\",\n \"currency\": \"EUR\",\n \"email\": \"\",\n \"orderChannel\": \"\",\n \"orderId\": \"\",\n \"orderItemList\": [\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"USD\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"lora\",\n \"properties\": {\n \"do_d11\": \"\",\n \"tempor_79\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n },\n {\n \"product\": {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"JPY\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"sim\",\n \"properties\": {\n \"dolore_a20\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n \"productAmount\": \"\",\n \"quantity\": \"\",\n \"taxIncludedProductAmount\": \"\"\n }\n ],\n \"preferredDeliveryDate\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"shippingAddress\": {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n },\n \"shippingAddressId\": \"\",\n \"shippingCost\": \"\",\n \"taxAmount\": \"\",\n \"taxIncludedInShippingCost\": \"\",\n \"taxOnShippingCost\": \"\",\n \"totalAmount\": \"\",\n \"withholdingTaxAmount\": \"\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-c64d7fe7-99c8-45d9-bb92-766a938c0ac0" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-f5216ad8-dc80-4e0f-8692-f6204caa44ba" } ], "id": "cafb169f-22ca-4f51-ad18-da0c386c791d", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-cafb169f-22ca-4f51-ad18-da0c386c791d" }, { "name": "products", "item": [ { "name": "List products", "id": "d1a9a097-5045-4f0b-bc2e-83c835a4034c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/products?campaign_code=", "host": [ "{{baseUrl}}" ], "path": [ "products" ], "query": [ { "key": "campaign_code", "value": "" } ] }, "description": "Returns a list of products." }, "response": [ { "id": "e4dfad0e-834d-44f2-8b27-e76194066a6b", "name": "A list of available products.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/products?campaign_code=", "host": [ "{{baseUrl}}" ], "path": [ "products" ], "query": [ { "key": "campaign_code", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"productList\": [\n {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"EUR\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"misc\",\n \"properties\": {\n \"ullamco_60\": \"\",\n \"adipisicing9\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n },\n {\n \"campaignCode\": \"\",\n \"consignorId\": \"\",\n \"consignorName\": \"\",\n \"count\": \"\",\n \"currency\": \"EUR\",\n \"description\": \"\",\n \"maxQuantity\": \"\",\n \"price\": \"\",\n \"priceByQuantityList\": [\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n },\n {\n \"minQuantity\": \"\",\n \"price\": \"\",\n \"taxIncludedPrice\": \"\"\n }\n ],\n \"productCode\": \"\",\n \"productInfoURL\": \"\",\n \"productName\": \"\",\n \"productType\": \"sigfox\",\n \"properties\": {\n \"ea_ccb\": \"\"\n },\n \"regularPrice\": \"\",\n \"taxIncludedPrice\": \"\",\n \"taxIncludedRegularPrice\": \"\",\n \"termsOfConsignorURL\": \"\",\n \"termsOfSolutionName\": \"\",\n \"termsOfSolutionURL\": \"\"\n }\n ],\n \"shippingCostList\": [\n {\n \"currency\": \"USD\",\n \"shippingArea\": \"okinawa\",\n \"shippingAreaName\": \"\",\n \"shippingCost\": \"\",\n \"size\": \"\"\n },\n {\n \"currency\": \"EUR\",\n \"shippingArea\": \"okinawa\",\n \"shippingAreaName\": \"\",\n \"shippingCost\": \"\",\n \"size\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-e4dfad0e-834d-44f2-8b27-e76194066a6b" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-d1a9a097-5045-4f0b-bc2e-83c835a4034c" } ], "id": "da827810-48ba-4ae2-bb6d-058c9eced39d", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-da827810-48ba-4ae2-bb6d-058c9eced39d" }, { "name": "operators", "item": [ { "name": "{operator_id}", "item": [ { "name": "shipping_addresses", "item": [ { "name": "{shipping_address_id}", "item": [ { "name": "Delete shipping address", "id": "6485c0ed-13f4-4874-865d-bc5eada6cee6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/operators/:operator_id/shipping_addresses/:shipping_address_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses", ":shipping_address_id" ], "variable": [ { "id": "33d86341-fd70-4849-9dd4-e508a26c97d2", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "abc6db5f-e95e-4b6c-bf17-0cb7df8a3985", "key": "shipping_address_id", "value": "", "description": "(Required) Shipping address ID." } ] }, "description": "Deletes a shipping address." }, "response": [ { "id": "060f9789-3d48-4e06-99e0-c4752a56cd53", "name": "OK.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/shipping_addresses/:shipping_address_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses", ":shipping_address_id" ], "variable": [ { "key": "operator_id" }, { "key": "shipping_address_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-060f9789-3d48-4e06-99e0-c4752a56cd53" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-6485c0ed-13f4-4874-865d-bc5eada6cee6" }, { "name": "Get shipping address", "id": "27945a6d-4d1d-4da6-b802-44cfb0c55897", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/shipping_addresses/:shipping_address_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses", ":shipping_address_id" ], "variable": [ { "id": "c2f061b6-4f36-43bf-ad79-3031f5517719", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "76c37c39-3b38-4a4a-bba8-7fa0a4ebd1d8", "key": "shipping_address_id", "value": "", "description": "(Required) Shipping address ID." } ] }, "description": "Returns a shipping address." }, "response": [ { "id": "20b4f764-56a7-4f02-af98-590f19fb94a1", "name": "OK.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/shipping_addresses/:shipping_address_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses", ":shipping_address_id" ], "variable": [ { "key": "operator_id" }, { "key": "shipping_address_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"phoneNumber\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingArea\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"department\": \"\",\n \"fullName\": \"\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-20b4f764-56a7-4f02-af98-590f19fb94a1" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-27945a6d-4d1d-4da6-b802-44cfb0c55897" }, { "name": "Update shipping address", "id": "d86c6aca-47c7-417b-bb57-b7052693c1a4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/shipping_addresses/:shipping_address_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses", ":shipping_address_id" ], "variable": [ { "id": "8dc2f15c-ee20-4153-8b43-33dccf85e2e4", "key": "operator_id", "value": "", "description": "(Required) Operator ID." }, { "id": "450d60a2-c9ce-47f2-802c-e45eb24756fb", "key": "shipping_address_id", "value": "", "description": "(Required) Shipping address ID." } ] }, "description": "Updates a shipping address." }, "response": [ { "id": "f3ee47f8-2095-41ea-99f6-336d156f8987", "name": "OK.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/shipping_addresses/:shipping_address_id", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses", ":shipping_address_id" ], "variable": [ { "key": "operator_id" }, { "key": "shipping_address_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-f3ee47f8-2095-41ea-99f6-336d156f8987" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-d86c6aca-47c7-417b-bb57-b7052693c1a4" } ], "id": "b5098368-e21d-4bfb-b7c5-62139f8223c1", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-b5098368-e21d-4bfb-b7c5-62139f8223c1" }, { "name": "List shipping addresses", "id": "366af61f-3dc1-4cd3-b3d5-353cb2d5dbd1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/shipping_addresses", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses" ], "variable": [ { "id": "1bad446e-f5ca-4de6-b0f5-0698f09e7006", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Returns a list of shipping addresses." }, "response": [ { "id": "b88cbc33-6f95-4e38-b01a-bad6fd364407", "name": "OK.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/operators/:operator_id/shipping_addresses", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses" ], "variable": [ { "key": "operator_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"shippingAddresses\": [\n {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"phoneNumber\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingArea\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"department\": \"\",\n \"fullName\": \"\"\n },\n {\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"phoneNumber\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingArea\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"department\": \"\",\n \"fullName\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-b88cbc33-6f95-4e38-b01a-bad6fd364407" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-366af61f-3dc1-4cd3-b3d5-353cb2d5dbd1" }, { "name": "Create shipping address", "id": "a6b9cc5b-47c0-411d-9e43-dedcd15260bc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Soracom-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/shipping_addresses", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses" ], "variable": [ { "id": "f86b0e7b-e641-436c-8608-a44407fc62f6", "key": "operator_id", "value": "", "description": "(Required) Operator ID." } ] }, "description": "Creates a new shipping address." }, "response": [ { "id": "3997b1db-c215-4f06-a5d1-d6922a5927dc", "name": "Shipping address was registered.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Soracom-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"countryCode\": \"\",\n \"department\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"phoneNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/operators/:operator_id/shipping_addresses", "host": [ "{{baseUrl}}" ], "path": [ "operators", ":operator_id", "shipping_addresses" ], "variable": [ { "key": "operator_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"addressLine1\": \"\",\n \"city\": \"\",\n \"phoneNumber\": \"\",\n \"shippingAddressId\": \"\",\n \"shippingArea\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"addressLine2\": \"\",\n \"building\": \"\",\n \"companyName\": \"\",\n \"department\": \"\",\n \"fullName\": \"\"\n}", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-3997b1db-c215-4f06-a5d1-d6922a5927dc" } ], "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-a6b9cc5b-47c0-411d-9e43-dedcd15260bc" } ], "id": "dfcfce6a-b842-4efe-a53f-dfd2c83c4fb1", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-dfcfce6a-b842-4efe-a53f-dfd2c83c4fb1" } ], "id": "35d7c31d-fcd1-41f0-b1c6-47122bfca871", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-35d7c31d-fcd1-41f0-b1c6-47122bfca871" } ], "id": "f52f8202-3338-4032-8517-073d485a3e16", "createdAt": "2026-06-05T15:18:40.000Z", "updatedAt": "2026-06-05T15:18:40.000Z", "uid": "35240-f52f8202-3338-4032-8517-073d485a3e16" } ], "variable": [ { "key": "baseUrl", "value": "https://api.soracom.io/v1" } ] }