CloudCockpit API documentation

Retrieve a Subscription

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

Retrieves a Subscription with the specified GUID identifier.

Headers

X-Tenant string Required

This header identifies which tenant to access with this request. This value should be an existent domain for the specified tenant.
Authorization string Required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Default value is Bearer eyJ0eXAiO....
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) Required

GUID Unique identifier for the customer. The subscription must belong to this customer, otherwise this request will fail.
subscriptionId string(uuid) Required

GUID Unique identifier for the subscription.

Responses

• 200

text/plain

text/plain application/json text/json

Success
Hide response attributes Show response attributes 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
  
  Hide status attributes Show status attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
- 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
  
  Hide termDuration attributes Show termDuration attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
- billingFrequency object
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequency attributes Show billingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
- nextBillingFrequency object
  
  Hide nextBillingFrequency attributes Show nextBillingFrequency attributes
  
  scheduledDate string(date-time) | null
  
  The schedule date to change billing frequency, it is also the current billing cycle end date
  
  billingFrequency object
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequency attributes Show billingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Hide segment attributes Show segment attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
- autoRenewEnabled boolean
  
  true if [automatic renew enabled]; otherwise, false.
- autoRenewSettings object
  
  Hide autoRenewSettings attributes Show autoRenewSettings attributes
  
  term object Required
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Hide term attributes Show term attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  billingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequency attributes Show billingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  quantity integer(int32) | null Required
  
  The quantity
  
  customTermEndDate string(date-time) | null
  
  The custom term end date
  
  Additional properties are NOT allowed
- margin object
  
  This value object contains the price margin for this entity.
  
  Hide margin attributes Show margin attributes
  
  marginRule object Required
  
  The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
  
  Hide marginRule attributes Show marginRule attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  value number(double) | null Required
  
  The value applied to this price margin. Should not be below 0 or above 999.
  
  Additional properties are NOT allowed
- internalId string | null
  
  The internal identifier.
- poNumber string | null
  
  The po number.
- offer object
  
  View model that represents an Offer.
  
  Hide offer attributes Show offer attributes
  
  id string(uuid)
  
  The id of the offer.
  
  name string | null
  
  The name of the offer.
  
  description string | null
  
  The offer description.
  
  imageUrl string | null
  
  The offer image URL.
  
  offerType object
  
  The offer type. Possible values: License, LicenseLegacy, SoftwareSubscription, PerpetualSoftware, AzurePlan, AzureReservation, AzureLegacy or AzureSavingsPlan.
  
  Hide offerType attributes Show offerType attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  billingType object
  
  The billing type for the offer. Possible values: License, Usage or None
  
  Hide billingType attributes Show billingType attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  prices array[object] | null
  
  View model that represents an offer price.
  
  Hide prices attributes Show prices attributes object
  
  termDuration object
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Hide termDuration attributes Show termDuration attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Hide segment attributes Show segment attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  region object
  
  Hide region attributes Show region attributes
  
  value string | null
  
  The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.
  
  Additional properties are NOT allowed
  
  billingFrequencies array[object] | null
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequencies attributes Show billingFrequencies attributes object
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  costPrice object
  
  Hide costPrice attributes Show costPrice attributes
  
  value number(double)
  
  The price value.
  
  currency object
  
  Hide currency attributes Show currency attributes
  
  name string | null
  
  The name of the currency.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  revenuePrice object
  
  Hide revenuePrice attributes Show revenuePrice attributes
  
  value number(double)
  
  The price value.
  
  currency object
  
  Hide currency attributes Show currency attributes
  
  name string | null
  
  The name of the currency.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  erpPrice object
  
  Hide erpPrice attributes Show erpPrice attributes
  
  value number(double)
  
  The price value.
  
  currency object
  
  Hide currency attributes Show currency attributes
  
  name string | null
  
  The name of the currency.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  providerName string | null
  
  The offer provider name.
  
  providerInstanceId string(uuid) | null
  
  The provider's instance identifier.
  
  isAddon boolean
  
  The value indicating whether this offer is addon.
  
  minQuantity integer(int32)
  
  The minimum quantity for this offer.
  
  maxQuantity integer(int32)
  
  The maximum quantity for this offer.
  
  hasPreRequisites boolean
  
  The value indicating whether this offer has pre requisite offers.
  
  preRequisites array[string] | null
  
  The list of pre requisite offers ids.
  
  isTrial boolean
  
  The value indicating whether this offer is a trial.
  
  providerOfferId string | null
  
  The provider's offer identifier.
  
  isDeleted boolean
  
  A Value indicating whether this offer is deleted and cannot be provisioned.
  
  Additional properties are NOT allowed
- offerPrice object
  
  View model that represents an offer price.
  
  Hide offerPrice attributes Show offerPrice attributes
  
  termDuration object
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Hide termDuration attributes Show termDuration attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Hide segment attributes Show segment attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  region object
  
  Hide region attributes Show region attributes
  
  value string | null
  
  The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.
  
  Additional properties are NOT allowed
  
  billingFrequencies array[object] | null
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequencies attributes Show billingFrequencies attributes object
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  costPrice object
  
  Hide costPrice attributes Show costPrice attributes
  
  value number(double)
  
  The price value.
  
  currency object
  
  Hide currency attributes Show currency attributes
  
  name string | null
  
  The name of the currency.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  revenuePrice object
  
  Hide revenuePrice attributes Show revenuePrice attributes
  
  value number(double)
  
  The price value.
  
  currency object
  
  Hide currency attributes Show currency attributes
  
  name string | null
  
  The name of the currency.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  erpPrice object
  
  Hide erpPrice attributes Show erpPrice attributes
  
  value number(double)
  
  The price value.
  
  currency object
  
  Hide currency attributes Show currency attributes
  
  name string | null
  
  The name of the currency.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- providerData string | null
  
  The subscription provider data.
- Additional properties are NOT allowed
Hide response attributes Show response attributes 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
  
  Hide status attributes Show status attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
- 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
  
  Hide termDuration attributes Show termDuration attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
- billingFrequency object
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequency attributes Show billingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
- nextBillingFrequency object
  
  Hide nextBillingFrequency attributes Show nextBillingFrequency attributes
  
  scheduledDate string(date-time) | null
  
  The schedule date to change billing frequency, it is also the current billing cycle end date
  
  billingFrequency object
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequency attributes Show billingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Hide segment attributes Show segment attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
- autoRenewEnabled boolean
  
  true if [automatic renew enabled]; otherwise, false.
- autoRenewSettings object
  
  Hide autoRenewSettings attributes Show autoRenewSettings attributes
  
  term object Required
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Hide term attributes Show term attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  billingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequency attributes Show billingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  quantity integer(int32) | null Required
  
  The quantity
  
  customTermEndDate string(date-time) | null
  
  The custom term end date
  
  Additional properties are NOT allowed
- margin object
  
  This value object contains the price margin for this entity.
  
  Hide margin attributes Show margin attributes
  
  marginRule object Required
  
  The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
  
  Hide marginRule attributes Show marginRule attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  value number(double) | null Required
  
  The value applied to this price margin. Should not be below 0 or above 999.
  
  Additional properties are NOT allowed
- internalId string | null
  
  The internal identifier.
- poNumber string | null
  
  The po number.
- offer object
  
  View model that represents an Offer.
  
  Hide offer attributes Show offer attributes
  
  id string(uuid)
  
  The id of the offer.
  
  name string | null
  
  The name of the offer.
  
  description string | null
  
  The offer description.
  
  imageUrl string | null
  
  The offer image URL.
  
  offerType object
  
  The offer type. Possible values: License, LicenseLegacy, SoftwareSubscription, PerpetualSoftware, AzurePlan, AzureReservation, AzureLegacy or AzureSavingsPlan.
  
  Hide offerType attributes Show offerType attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  billingType object
  
  The billing type for the offer. Possible values: License, Usage or None
  
  Hide billingType attributes Show billingType attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  prices array[object] | null
  
  View model that represents an offer price.
  
  Hide prices attributes Show prices attributes object
  
  termDuration object
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Hide termDuration attributes Show termDuration attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Hide segment attributes Show segment attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  region object
  
  Hide region attributes Show region attributes
  
  value string | null
  
  The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.
  
  Additional properties are NOT allowed
  
  billingFrequencies array[object] | null
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequencies attributes Show billingFrequencies attributes object
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  costPrice object
  
  Hide costPrice attributes Show costPrice attributes
  
  value number(double)
  
  The price value.
  
  currency object
  
  Hide currency attributes Show currency attributes
  
  name string | null
  
  The name of the currency.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  revenuePrice object
  
  Hide revenuePrice attributes Show revenuePrice attributes
  
  value number(double)
  
  The price value.
  
  currency object
  
  Hide currency attributes Show currency attributes
  
  name string | null
  
  The name of the currency.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  erpPrice object
  
  Hide erpPrice attributes Show erpPrice attributes
  
  value number(double)
  
  The price value.
  
  currency object
  
  Hide currency attributes Show currency attributes
  
  name string | null
  
  The name of the currency.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  providerName string | null
  
  The offer provider name.
  
  providerInstanceId string(uuid) | null
  
  The provider's instance identifier.
  
  isAddon boolean
  
  The value indicating whether this offer is addon.
  
  minQuantity integer(int32)
  
  The minimum quantity for this offer.
  
  maxQuantity integer(int32)
  
  The maximum quantity for this offer.
  
  hasPreRequisites boolean
  
  The value indicating whether this offer has pre requisite offers.
  
  preRequisites array[string] | null
  
  The list of pre requisite offers ids.
  
  isTrial boolean
  
  The value indicating whether this offer is a trial.
  
  providerOfferId string | null
  
  The provider's offer identifier.
  
  isDeleted boolean
  
  A Value indicating whether this offer is deleted and cannot be provisioned.
  
  Additional properties are NOT allowed
- offerPrice object
  
  View model that represents an offer price.
  
  Hide offerPrice attributes Show offerPrice attributes
  
  termDuration object
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Hide termDuration attributes Show termDuration attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Hide segment attributes Show segment attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  region object
  
  Hide region attributes Show region attributes
  
  value string | null
  
  The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.
  
  Additional properties are NOT allowed
  
  billingFrequencies array[object] | null
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequencies attributes Show billingFrequencies attributes object
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  costPrice object
  
  Hide costPrice attributes Show costPrice attributes
  
  value number(double)
  
  The price value.
  
  currency object
  
  Hide currency attributes Show currency attributes
  
  name string | null
  
  The name of the currency.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  revenuePrice object
  
  Hide revenuePrice attributes Show revenuePrice attributes
  
  value number(double)
  
  The price value.
  
  currency object
  
  Hide currency attributes Show currency attributes
  
  name string | null
  
  The name of the currency.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  erpPrice object
  
  Hide erpPrice attributes Show erpPrice attributes
  
  value number(double)
  
  The price value.
  
  currency object
  
  Hide currency attributes Show currency attributes
  
  name string | null
  
  The name of the currency.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- providerData string | null
  
  The subscription provider data.
- Additional properties are NOT allowed
Hide response attributes Show response attributes 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
  
  Hide status attributes Show status attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
- 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
  
  Hide termDuration attributes Show termDuration attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
- billingFrequency object
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequency attributes Show billingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
- nextBillingFrequency object
  
  Hide nextBillingFrequency attributes Show nextBillingFrequency attributes
  
  scheduledDate string(date-time) | null
  
  The schedule date to change billing frequency, it is also the current billing cycle end date
  
  billingFrequency object
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequency attributes Show billingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Hide segment attributes Show segment attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
- autoRenewEnabled boolean
  
  true if [automatic renew enabled]; otherwise, false.
- autoRenewSettings object
  
  Hide autoRenewSettings attributes Show autoRenewSettings attributes
  
  term object Required
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Hide term attributes Show term attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  billingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequency attributes Show billingFrequency attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  quantity integer(int32) | null Required
  
  The quantity
  
  customTermEndDate string(date-time) | null
  
  The custom term end date
  
  Additional properties are NOT allowed
- margin object
  
  This value object contains the price margin for this entity.
  
  Hide margin attributes Show margin attributes
  
  marginRule object Required
  
  The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
  
  Hide marginRule attributes Show marginRule attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  value number(double) | null Required
  
  The value applied to this price margin. Should not be below 0 or above 999.
  
  Additional properties are NOT allowed
- internalId string | null
  
  The internal identifier.
- poNumber string | null
  
  The po number.
- offer object
  
  View model that represents an Offer.
  
  Hide offer attributes Show offer attributes
  
  id string(uuid)
  
  The id of the offer.
  
  name string | null
  
  The name of the offer.
  
  description string | null
  
  The offer description.
  
  imageUrl string | null
  
  The offer image URL.
  
  offerType object
  
  The offer type. Possible values: License, LicenseLegacy, SoftwareSubscription, PerpetualSoftware, AzurePlan, AzureReservation, AzureLegacy or AzureSavingsPlan.
  
  Hide offerType attributes Show offerType attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  billingType object
  
  The billing type for the offer. Possible values: License, Usage or None
  
  Hide billingType attributes Show billingType attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  prices array[object] | null
  
  View model that represents an offer price.
  
  Hide prices attributes Show prices attributes object
  
  termDuration object
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Hide termDuration attributes Show termDuration attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Hide segment attributes Show segment attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  region object
  
  Hide region attributes Show region attributes
  
  value string | null
  
  The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.
  
  Additional properties are NOT allowed
  
  billingFrequencies array[object] | null
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequencies attributes Show billingFrequencies attributes object
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  costPrice object
  
  Hide costPrice attributes Show costPrice attributes
  
  value number(double)
  
  The price value.
  
  currency object
  
  Hide currency attributes Show currency attributes
  
  name string | null
  
  The name of the currency.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  revenuePrice object
  
  Hide revenuePrice attributes Show revenuePrice attributes
  
  value number(double)
  
  The price value.
  
  currency object
  
  Hide currency attributes Show currency attributes
  
  name string | null
  
  The name of the currency.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  erpPrice object
  
  Hide erpPrice attributes Show erpPrice attributes
  
  value number(double)
  
  The price value.
  
  currency object
  
  Hide currency attributes Show currency attributes
  
  name string | null
  
  The name of the currency.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  providerName string | null
  
  The offer provider name.
  
  providerInstanceId string(uuid) | null
  
  The provider's instance identifier.
  
  isAddon boolean
  
  The value indicating whether this offer is addon.
  
  minQuantity integer(int32)
  
  The minimum quantity for this offer.
  
  maxQuantity integer(int32)
  
  The maximum quantity for this offer.
  
  hasPreRequisites boolean
  
  The value indicating whether this offer has pre requisite offers.
  
  preRequisites array[string] | null
  
  The list of pre requisite offers ids.
  
  isTrial boolean
  
  The value indicating whether this offer is a trial.
  
  providerOfferId string | null
  
  The provider's offer identifier.
  
  isDeleted boolean
  
  A Value indicating whether this offer is deleted and cannot be provisioned.
  
  Additional properties are NOT allowed
- offerPrice object
  
  View model that represents an offer price.
  
  Hide offerPrice attributes Show offerPrice attributes
  
  termDuration object
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Hide termDuration attributes Show termDuration attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Hide segment attributes Show segment attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  region object
  
  Hide region attributes Show region attributes
  
  value string | null
  
  The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.
  
  Additional properties are NOT allowed
  
  billingFrequencies array[object] | null
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Hide billingFrequencies attributes Show billingFrequencies attributes object
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
  
  costPrice object
  
  Hide costPrice attributes Show costPrice attributes
  
  value number(double)
  
  The price value.
  
  currency object
  
  Hide currency attributes Show currency attributes
  
  name string | null
  
  The name of the currency.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  revenuePrice object
  
  Hide revenuePrice attributes Show revenuePrice attributes
  
  value number(double)
  
  The price value.
  
  currency object
  
  Hide currency attributes Show currency attributes
  
  name string | null
  
  The name of the currency.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  erpPrice object
  
  Hide erpPrice attributes Show erpPrice attributes
  
  value number(double)
  
  The price value.
  
  currency object
  
  Hide currency attributes Show currency attributes
  
  name string | null
  
  The name of the currency.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- providerData string | null
  
  The subscription provider data.
- Additional properties are NOT allowed
• 400

text/plain

text/plain application/json text/json

Bad Request
Hide response attributes Show response attributes 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
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Hide response attributes Show response attributes 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
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Hide response attributes Show response attributes 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
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
• 401

Unauthorized
• 403

Forbidden
• 500

text/plain

text/plain application/json text/json

Server Error
Hide response attributes Show response attributes 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
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Hide response attributes Show response attributes 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
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Hide response attributes Show response attributes 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
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed

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

curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/customers/{customerId}/subscriptions/{subscriptionId} \
 -H "X-Tenant: string" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string"

Response examples (200)

{
  "id": "string",
  "customerId": "string",
  "providerInstanceId": "string",
  "resellerId": "string",
  "name": "string",
  "providerSubscriptionId": "string",
  "status": {
    "name": "string"
  },
  "startDate": "2024-05-04T09:42:00+00:00",
  "endDate": "2024-05-04T09:42:00+00:00",
  "cancellationAllowedUntil": "2024-05-04T09:42:00+00:00",
  "quantity": 42,
  "termDuration": {
    "name": "string"
  },
  "billingFrequency": {
    "name": "string"
  },
  "nextBillingFrequency": {
    "scheduledDate": "2024-05-04T09:42:00+00:00",
    "billingFrequency": {
      "name": "string"
    }
  },
  "segment": {
    "name": "string"
  },
  "autoRenewEnabled": true,
  "autoRenewSettings": {
    "term": {
      "name": "string"
    },
    "billingFrequency": {
      "name": "string"
    },
    "quantity": 42,
    "customTermEndDate": "2024-05-04T09:42:00+00:00"
  },
  "margin": {
    "marginRule": {
      "name": "string"
    },
    "value": 42.0
  },
  "internalId": "string",
  "poNumber": "string",
  "offer": {
    "id": "string",
    "name": "string",
    "description": "string",
    "imageUrl": "string",
    "offerType": {
      "name": "string"
    },
    "billingType": {
      "name": "string"
    },
    "prices": [
      {
        "termDuration": {
          "name": "string"
        },
        "segment": {
          "name": "string"
        },
        "region": {
          "value": "string"
        },
        "billingFrequencies": [
          {
            "name": "string"
          }
        ],
        "costPrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        },
        "revenuePrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        },
        "erpPrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        }
      }
    ],
    "providerName": "string",
    "providerInstanceId": "string",
    "isAddon": true,
    "minQuantity": 42,
    "maxQuantity": 42,
    "hasPreRequisites": true,
    "preRequisites": [
      "string"
    ],
    "isTrial": true,
    "providerOfferId": "string",
    "isDeleted": true
  },
  "offerPrice": {
    "termDuration": {
      "name": "string"
    },
    "segment": {
      "name": "string"
    },
    "region": {
      "value": "string"
    },
    "billingFrequencies": [
      {
        "name": "string"
      }
    ],
    "costPrice": {
      "value": 42.0,
      "currency": {
        "name": "string"
      }
    },
    "revenuePrice": {
      "value": 42.0,
      "currency": {
        "name": "string"
      }
    },
    "erpPrice": {
      "value": 42.0,
      "currency": {
        "name": "string"
      }
    }
  },
  "providerData": "string"
}

Response examples (200)

{
  "id": "string",
  "customerId": "string",
  "providerInstanceId": "string",
  "resellerId": "string",
  "name": "string",
  "providerSubscriptionId": "string",
  "status": {
    "name": "string"
  },
  "startDate": "2024-05-04T09:42:00+00:00",
  "endDate": "2024-05-04T09:42:00+00:00",
  "cancellationAllowedUntil": "2024-05-04T09:42:00+00:00",
  "quantity": 42,
  "termDuration": {
    "name": "string"
  },
  "billingFrequency": {
    "name": "string"
  },
  "nextBillingFrequency": {
    "scheduledDate": "2024-05-04T09:42:00+00:00",
    "billingFrequency": {
      "name": "string"
    }
  },
  "segment": {
    "name": "string"
  },
  "autoRenewEnabled": true,
  "autoRenewSettings": {
    "term": {
      "name": "string"
    },
    "billingFrequency": {
      "name": "string"
    },
    "quantity": 42,
    "customTermEndDate": "2024-05-04T09:42:00+00:00"
  },
  "margin": {
    "marginRule": {
      "name": "string"
    },
    "value": 42.0
  },
  "internalId": "string",
  "poNumber": "string",
  "offer": {
    "id": "string",
    "name": "string",
    "description": "string",
    "imageUrl": "string",
    "offerType": {
      "name": "string"
    },
    "billingType": {
      "name": "string"
    },
    "prices": [
      {
        "termDuration": {
          "name": "string"
        },
        "segment": {
          "name": "string"
        },
        "region": {
          "value": "string"
        },
        "billingFrequencies": [
          {
            "name": "string"
          }
        ],
        "costPrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        },
        "revenuePrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        },
        "erpPrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        }
      }
    ],
    "providerName": "string",
    "providerInstanceId": "string",
    "isAddon": true,
    "minQuantity": 42,
    "maxQuantity": 42,
    "hasPreRequisites": true,
    "preRequisites": [
      "string"
    ],
    "isTrial": true,
    "providerOfferId": "string",
    "isDeleted": true
  },
  "offerPrice": {
    "termDuration": {
      "name": "string"
    },
    "segment": {
      "name": "string"
    },
    "region": {
      "value": "string"
    },
    "billingFrequencies": [
      {
        "name": "string"
      }
    ],
    "costPrice": {
      "value": 42.0,
      "currency": {
        "name": "string"
      }
    },
    "revenuePrice": {
      "value": 42.0,
      "currency": {
        "name": "string"
      }
    },
    "erpPrice": {
      "value": 42.0,
      "currency": {
        "name": "string"
      }
    }
  },
  "providerData": "string"
}

Response examples (400)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (400)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (500)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (500)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}