Subscription Versions
List Subscription Versions
Customers
Events & Usage Metering
Invoices
Subscriptions
Subscription Versions
List Subscription Versions
Retrieve a list of all subscription versions
GET
/
subscriptions
/
{id}
/
versions
curl --request GET \
--url https://api.alguna.io/subscriptions/{id}/versions \
--header 'Authorization: Bearer <token>'
{
"versions": [
{
"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": "subver_0000000000000002",
"createdAt": "2023-12-01T10:30:00Z",
"organizationId": "00000000-0000-0000-0000-000000000001",
"quoteId": "quo_0000000000000001",
"changeDescription": "Initial subscription version",
"startDate": "2024-01-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"]
}
],
"status": "superseded"
}
]
}
Retrieves a list of all subscription versions.
Path Parameters
The unique identifier of the subscription to retrieve versions for
Response
{
"versions": [
{
"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": "subver_0000000000000002",
"createdAt": "2023-12-01T10:30:00Z",
"organizationId": "00000000-0000-0000-0000-000000000001",
"quoteId": "quo_0000000000000001",
"changeDescription": "Initial subscription version",
"startDate": "2024-01-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"]
}
],
"status": "superseded"
}
]
}
List of subscription version objects
Unique identifier for the subscription version
When the subscription version was created in ISO 8601 format
The organization ID that owns this subscription version
The quote ID associated with this subscription version
Optional description of what changed in this version
Optional start date for this subscription version in ISO 8601 format
End date determined by us for this subscription version in ISO 8601 format. If empty, the subscription version is open-ended
Current status of the subscription version. Possible values: draft
,
active
, superseded
, canceled
curl --request GET \
--url https://api.alguna.io/subscriptions/{id}/versions \
--header 'Authorization: Bearer <token>'
{
"versions": [
{
"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": "subver_0000000000000002",
"createdAt": "2023-12-01T10:30:00Z",
"organizationId": "00000000-0000-0000-0000-000000000001",
"quoteId": "quo_0000000000000001",
"changeDescription": "Initial subscription version",
"startDate": "2024-01-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"]
}
],
"status": "superseded"
}
]
}