# Retrieve a Subscription

**GET /v1/customers/{customerId}/subscriptions/{subscriptionId}**

Retrieves a Subscription with the specified GUID identifier.


## Servers
- https://api.cloudcockpit.com: https://api.cloudcockpit.com ()


## Authentication methods
- Bearer auth


## Parameters
### Headers
- **X-Tenant** (string)
  The domain used to access the portal.
- **Authorization** (string)
  JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"
- **X-Correlation-Id** (string(uuid))
  This header is optional and by setting it you can correlate the audit logs made by this request.

### Path parameters
- **customerId** (string(uuid))
  GUID Unique identifier for the customer. The subscription must belong to this customer, otherwise this request will fail.
- **subscriptionId** (string(uuid))
  GUID Unique identifier for the subscription.



## Responses
### 200
OK

#### Body: application/json (object)
- **id** (string(uuid))
  The id of the subscription.
- **customerId** (string(uuid))
  The customer id of the subscription.
- **providerInstanceId** (string(uuid))
  The provider instance id of the subscription.
- **resellerId** (string(uuid) | null)
  The reseller id of the subscription.
- **name** (string | null)
  The friendly name of the subscription.
- **providerSubscriptionId** (string | null)
  The provider subscription identifier.
- **status** (object)

- **startDate** (string(date-time))
  The start date of the subscription.
- **endDate** (string(date-time))
  The end date of the subscription.
- **cancellationAllowedUntil** (string(date-time) | null)
  The limit date to cancelled the subscription.
- **quantity** (integer(int32))
  The quantity of the subscription.
- **termDuration** (object)
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
- **billingFrequency** (object)
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
- **nextBillingFrequency** (object)

- **segment** (object)
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
- **autoRenewEnabled** (boolean)
  `true` if [automatic renew enabled]; otherwise, `false`.
- **autoRenewSettings** (object)

- **margin** (object)
  This value object contains the price margin for this entity.
- **internalId** (string | null)
  The internal identifier.
- **poNumber** (string | null)
  The po number.
- **offer** (object)
  View model that represents an Offer.
- **offerPrice** (object)
  View model that represents an offer price.
- **providerData** (string | null)
  The subscription provider data.

### 400
Bad Request

#### Body: application/json (object)
- **statusCode** (integer(int32))
  The HTTP status code that represents a specific error scenario.
- **type** (string | null)
  The type of error that occurred.
- **description** (string | null)
  Describes the error scenario that occurred.
- **correlationId** (string | null)
  The correlationId of the request that originated the error.
- **errors** (array[object] | null)
  A list containing the detail of the errors that occurred in this error scenario.

### 401
Unauthorized

### 403
Forbidden

### 500
Internal Server Error

#### Body: application/json (object)
- **statusCode** (integer(int32))
  The HTTP status code that represents a specific error scenario.
- **type** (string | null)
  The type of error that occurred.
- **description** (string | null)
  Describes the error scenario that occurred.
- **correlationId** (string | null)
  The correlationId of the request that originated the error.
- **errors** (array[object] | null)
  A list containing the detail of the errors that occurred in this error scenario.


[Powered by Bump.sh](https://bump.sh)