Get Subscription Detail API Documentation – 3D Measure Up
Get Subscription Detail API Documentation - 3D Measure Up Get Subscription Detail API Usage: HTTP Specification STEPS for using get subscription detail API Follow the steps below to retrieve subscription details using the API. 1. HTTP Method GET URL https://cust.3dmu.prototechsolutions.com/prod/customer/subscription/getDetails Authentication The /getDetails API requires an API key for authentication. This key must be included in the request header. Headers x-api-key: Must be x-api-key: <API_KEY>, where <API_KEY> is assigned to a user by Prototech Solutions. Content-Type: application/json Query Parameters This endpoint does not require any query parameters. 2. Steps to Use the API 1. Contact the 3D Measure Up team for a valid API key. Visit: API Key Page Click on Settings to view the API key. 2. Construct a GET request to: https://cust.3dmu.prototechsolutions.com/prod/customer/subscription/getDetails 3. Include the API key in the header as x-api-key: Your-API-Key. 4. Send the request and wait for the response. API ResponsesSuccess Response (200 OK) If the plan is not "pay-as-you-go": { "body": { "data": { "planInfo": { "name": "startup", "subscribed_on": "28 Jan 2025 11:54:51", "expirydate": "27 Feb 2025 00:00:00", "scan": 5, "bespoke": 10 }, "availableUsage": { "remainingScan": 5, "remainingBespoke": 10 } } } } If the plan is "pay-as-you-go": { "body": { "data": { "planInfo": { "name": "payasyougo", "subscribed_on": "04 Sept 2024 20:33:17", "expirydate": "04 Sept 2025 00:00:00" }, "tokensUsage": { "totalTokens": 10000, "availableTokens": 7204 } } } } Error Responses 403 Forbidden - Access Denied { "status": "error", "message": "Access denied" } 403 Forbidden - Missing Authentication Token { "message": "Missing Authentication Token" } 404 Not Found - No Active Subscription { "message": "Active subscription not found" } Notes Ensure that the API key is valid and active. The remainingScan and remainingBespoke fields indicate the user's remaining usage quota. If you have any questions or concerns, please contact our experts today at: 3dmeasureup@prototechsolutions.com