Get Subscription V4 Using GET

• Subscriptions V4

Retrieve a subscription by its ID.

Access Policy

Role	User Accounts	Service Accounts (Client Credentials Applications)
Organization Owner	✔️	✔️
Billing Read-only	✔️	✔️

Request

URI

GET

https://{api_host}/csp/gateway/commerce/api/v4/subscriptions/{subscriptionId}

COPY

Path Parameters

string

subscriptionId

Required

subscriptionId

---

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Hide Details

OK

Returns V4SubscriptionResponse of type(s) application/json

{
    "billingAccountId": "db36fc9b-6fde-4f10-8f32-2b2524a574fc",
    "billingEngineSubscriptionId": "M123445678",
    "lastUpdateDateTime": "2024-01-30T00:05:01.194Z",
    "orgId": "485a55fc-b853-40ee-b869-a1b2988e509c",
    "quantity": "500",
    "serialNumber": "52331152-1-1",
    "serviceDefinitionId": "d27a99af-f433-4427-a58a-acdc01c9e3f8",
    "serviceEndDate": "2024-12-25",
    "serviceStartDate": "2024-01-25",
    "sku": "TBD",
    "status": "ACTIVE",
    "subscriptionId": "f9971a9e-de15-4abb-a732-a24bfa3378a6",
    "subscriptionType": "PAID",
    "v3BillingModel": "string",
    "v3ChargeId": "VOD-HS",
    "v3Datacenter": "A1",
    "v3SubscriptionId": "f9971a9e-de15-4abb-a732-a24bfa3378a6",
    "v3SubscriptionType": "string"
}

string As uuid As uuid

billingAccountId

Required

The billing account used, for compatibility only

string

billingEngineSubscriptionId

Optional

Legacy only - if this is a migrated subscription from SAP then Mxxx number

string As date-time As date-time

lastUpdateDateTime

Required

Last time this subscription was updated in VCF

string

orgId

Required

The subscribing org id

string

quantity

Optional

The quantity

string

serialNumber

Required

The GTO serial number

string

serviceDefinitionId

Required

The service definition ID that this subscription belongs to

string

serviceEndDate

Optional

End date, YYYY-MM-DD format. Date is in PST timezone

string

serviceStartDate

Optional

Start date, YYYY-MM-DD format. Date is in PST timezone

string

sku

Optional

Item number/part number ordered in the ordering system

string

status

Required

Status

Possible values are : ACTIVE, SUSPENDED, TERMINATED,

string

subscriptionId

Required

The VCF backend subscription id

string

subscriptionType

Optional

Subscription type

Possible values are : PAID, TRIAL,

string

v3BillingModel

Optional

The billing model of the service definition id on the offer group

Possible values are : COMMIT_REQUIRED, COMMIT_OPTIONAL, COMMIT_ONLY,

string

v3ChargeId

Optional

The legacy subscription charge id if applicable

string

v3Datacenter

Optional

The legacy subscription data center if applicable

string

v3SubscriptionId

Optional

If this is a migrated subscription then the older v3 subscription id

string

v3SubscriptionType

Optional

Legacy Subscription Type, current choice: COMMIT, ONDEMAND. For migrated v3 subscriptions only

Possible values are : ONDEMAND, COMMIT,

401

Hide Details

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

403

Hide Details

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

404

Hide Details

Request error, see error code for details

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

429

Hide Details

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

500

Hide Details

Unexpected error

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/commerce/api/v4/subscriptions/{subscriptionId}
                

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Subscriptions V4 Operations

GET

Get Paged Subscriptions V4 Using GET

GET

Get Subscription V4 Using GET