GET
/
subscriptions
/
{id}
/
versions
/
{versionId}
curl --request GET \
  --url https://api.alguna.io/subscriptions/{id}/versions/{versionId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "subver_0000000000000001",
  "createdAt": "2024-01-01T12:00:00Z",
  "organizationId": "00000000-0000-0000-0000-000000000001",
  "quoteId": "quo_0000000000000001",
  "changeDescription": "Added new features to enterprise plan",
  "startDate": "2024-02-01T00:00:00Z",
  "endDate": "2024-12-31T23:59:59Z",
  "priceGroups": [
    {
      "name": "Core Features",
      "description": "Essential platform capabilities",
      "bundleId": "bun_0000000000000001",
      "priceIds": [
        "pri_0000000000000001",
        "pri_0000000000000002",
        "pri_0000000000000003"
      ]
    },
    {
      "name": "Add-ons",
      "description": "Optional additional features",
      "bundleId": "bun_0000000000000002",
      "priceIds": ["pri_0000000000000004", "pri_0000000000000005"]
    }
  ],
  "status": "active"
}

Retrieves the details of an existing subscription version. You need to supply the unique subscription identifier and the version identifier.

Path Parameters

id
string
required

The unique identifier of the subscription to retrieve

versionId
string
required

The unique identifier of the subscription version to retrieve

Response

{
  "id": "subver_0000000000000001",
  "createdAt": "2024-01-01T12:00:00Z",
  "organizationId": "00000000-0000-0000-0000-000000000001",
  "quoteId": "quo_0000000000000001",
  "changeDescription": "Added new features to enterprise plan",
  "startDate": "2024-02-01T00:00:00Z",
  "endDate": "2024-12-31T23:59:59Z",
  "priceGroups": [
    {
      "name": "Core Features",
      "description": "Essential platform capabilities",
      "bundleId": "bun_0000000000000001",
      "priceIds": [
        "pri_0000000000000001",
        "pri_0000000000000002",
        "pri_0000000000000003"
      ]
    },
    {
      "name": "Add-ons",
      "description": "Optional additional features",
      "bundleId": "bun_0000000000000002",
      "priceIds": ["pri_0000000000000004", "pri_0000000000000005"]
    }
  ],
  "status": "active"
}
id
string

Unique identifier for the subscription version

createdAt
datetime

When the subscription version was created in ISO 8601 format

organizationId
uuid

The organization ID that owns this subscription version

quoteId
string

The quote ID associated with this subscription version

changeDescription
string

Optional description of what changed in this version

startDate
datetime

Optional start date for this subscription version in ISO 8601 format

endDate
datetime

End date determined by us for this subscription version in ISO 8601 format. If empty, the subscription version is open-ended

priceGroups
array

Groups of prices included in this subscription version

status
string

Current status of the subscription version. Possible values: draft, active, superseded, canceled