Retrieve a subscription

GET

/subscriptions/{subscriptionId}

Retrieve a subscription by subscription Id

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api-sandbox.saaslogic.io/v1/subscriptions/4ef403a0-b7eb-4731-9a7b-df7962aa481f' \
--header 'Authorization;' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "customerId": "550e8400-e29b-41d4-a716-446655440000",
    "productId": "2a9d72c5-1c78-4b1b-bd12-4f4d76e9c2b7",
    "customerAddressId": "c0a80123-12b4-4c56-abc7-89d4ef567890",
    "planId": "d6f7e5a1-3c47-4a78-9b23-67f3e2d5a4b8",
    "billingFrequencyId": "9f8b7a6c-5d4e-4c3b-8a2b-1f0d9e7c6a5b",
    "subscriptionId": "7a3e2b1c-8d4f-5a6b-9f0e-2c7d1a4b3c8d",
    "subscriptionStartDate": "2025-03-18T00:00:00",
    "billingCycleStartDate": "2025-03-01T00:00:00",
    "isAutoRenewEnabled": false,
    "subscriptionAttributes": [
        {
            "attributeName": "Contract Type",
            "attributeValue": "Annual"
        }
    ],
    "resourceQuantities": [
        {
            "resourceId": "5d2b3a1e-8c4f-6b7a-9f0e-2c1d4a3b8c7d",
            "resourceName": "Storage Space",
            "quantity": "200"
        }
    ],
    "addons": [
        {
            "addonId": "3e7a2b1c-9d4f-5a6b-0f1e-2c7d8a4b3c8d",
            "addonName": "Storage100",
            "addonType": "Non-Recurring",
            "billingFrequencyId": "f7a6b5c4-d3e2-1f0e-9b8d-2c7a4b3c8d5e",
            "billingFrequencyName": "Monthly",
            "resourceName": "Backup Storage",
            "quantity": "50",
            "resourceUOMId": "6e7a2b1d-3d2f-7a6c-0f1e-2c7d8a4b3c8d",
            "resourceUOMName": "GB"
        }
    ],
    "isTrail": false,
    "isGenerateInvoiceForCurrentCycle": false
}

Request

Path Params

Header Params

Responses

🟢200Success

application/json

Body

🔴500ErrorResponse

Create a product subscription

Create Customer and Subscription