Retrieve a Subscription

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

Retrieves a Subscription with the specified GUID identifier.

Headers

X-Tenant string Required

The domain used to access the portal.
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

OK
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
  
  Additional properties are NOT allowed.
  
  Hide status attribute Show status attribute object
  
  name string | null
  
  The name of the enumeration.
- 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
  
  Additional properties are NOT allowed.
  
  Hide termDuration attribute Show termDuration attribute object
  
  name string | null
  
  The name of the enumeration.
- billingFrequency object
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Additional properties are NOT allowed.
  
  Hide billingFrequency attribute Show billingFrequency attribute object
  
  name string | null
  
  The name of the enumeration.
- nextBillingFrequency object
  
  Additional properties are NOT allowed.
  
  Hide nextBillingFrequency attributes Show nextBillingFrequency attributes object
  
  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
  
  Additional properties are NOT allowed.
  
  Hide billingFrequency attribute Show billingFrequency attribute object
  
  name string | null
  
  The name of the enumeration.
- segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Additional properties are NOT allowed.
  
  Hide segment attribute Show segment attribute object
  
  name string | null
  
  The name of the enumeration.
- autoRenewEnabled boolean
  
  true if [automatic renew enabled]; otherwise, false.
- autoRenewSettings object
  
  Additional properties are NOT allowed.
  
  Hide autoRenewSettings attributes Show autoRenewSettings attributes object
  
  term object Required
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Additional properties are NOT allowed.
  
  Hide term attribute Show term attribute object
  
  name string | null
  
  The name of the enumeration.
  
  billingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Additional properties are NOT allowed.
  
  Hide billingFrequency attribute Show billingFrequency attribute object
  
  name string | null
  
  The name of the enumeration.
  
  quantity integer(int32) | null Required
  
  The quantity
  
  customTermEndDate string(date-time) | null
  
  The custom term end date
- margin object
  
  This value object contains the price margin for this entity.
  
  Additional properties are NOT allowed.
  
  Hide margin attributes Show margin attributes object
  
  marginRule object Required
  
  The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
  
  Additional properties are NOT allowed.
  
  Hide marginRule attribute Show marginRule attribute object
  
  name string | null
  
  The name of the enumeration.
  
  value number(double) | null Required
  
  The value applied to this price margin. Should not be below 0 or above 999.
- internalId string | null
  
  The internal identifier.
- poNumber string | null
  
  The po number.
- offer object
  
  View model that represents an Offer.
  
  Additional properties are NOT allowed.
  
  Hide offer attributes Show offer attributes object
  
  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.
  
  Additional properties are NOT allowed.
  
  Hide offerType attribute Show offerType attribute object
  
  name string | null
  
  The name of the enumeration.
  
  billingType object
  
  The billing type for the offer. Possible values: License, Usage or None
  
  Additional properties are NOT allowed.
  
  Hide billingType attribute Show billingType attribute object
  
  name string | null
  
  The name of the enumeration.
  
  prices array[object] | null
  
  The offer prices.
  
  Hide prices attributes Show prices attributes object
  
  termDuration object
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Additional properties are NOT allowed.
  
  Hide termDuration attribute Show termDuration attribute object
  
  name string | null
  
  The name of the enumeration.
  
  segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Additional properties are NOT allowed.
  
  Hide segment attribute Show segment attribute object
  
  name string | null
  
  The name of the enumeration.
  
  region object
  
  Additional properties are NOT allowed.
  
  Hide region attribute Show region attribute object
  
  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.
  
  billingFrequencies array[object] | null
  
  The offer price Billing Frequencies.
  
  Hide billingFrequencies attribute Show billingFrequencies attribute object
  
  name string | null
  
  The name of the enumeration.
  
  costPrice object
  
  Additional properties are NOT allowed.
  
  Hide costPrice attributes Show costPrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  revenuePrice object
  
  Additional properties are NOT allowed.
  
  Hide revenuePrice attributes Show revenuePrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  erpPrice object
  
  Additional properties are NOT allowed.
  
  Hide erpPrice attributes Show erpPrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  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.
- offerPrice object
  
  View model that represents an offer price.
  
  Additional properties are NOT allowed.
  
  Hide offerPrice attributes Show offerPrice attributes object
  
  termDuration object
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Additional properties are NOT allowed.
  
  Hide termDuration attribute Show termDuration attribute object
  
  name string | null
  
  The name of the enumeration.
  
  segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Additional properties are NOT allowed.
  
  Hide segment attribute Show segment attribute object
  
  name string | null
  
  The name of the enumeration.
  
  region object
  
  Additional properties are NOT allowed.
  
  Hide region attribute Show region attribute object
  
  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.
  
  billingFrequencies array[object] | null
  
  The offer price Billing Frequencies.
  
  Hide billingFrequencies attribute Show billingFrequencies attribute object
  
  name string | null
  
  The name of the enumeration.
  
  costPrice object
  
  Additional properties are NOT allowed.
  
  Hide costPrice attributes Show costPrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  revenuePrice object
  
  Additional properties are NOT allowed.
  
  Hide revenuePrice attributes Show revenuePrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  erpPrice object
  
  Additional properties are NOT allowed.
  
  Hide erpPrice attributes Show erpPrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
- providerData string | null
  
  The subscription provider data.
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
  
  Additional properties are NOT allowed.
  
  Hide status attribute Show status attribute object
  
  name string | null
  
  The name of the enumeration.
- 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
  
  Additional properties are NOT allowed.
  
  Hide termDuration attribute Show termDuration attribute object
  
  name string | null
  
  The name of the enumeration.
- billingFrequency object
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Additional properties are NOT allowed.
  
  Hide billingFrequency attribute Show billingFrequency attribute object
  
  name string | null
  
  The name of the enumeration.
- nextBillingFrequency object
  
  Additional properties are NOT allowed.
  
  Hide nextBillingFrequency attributes Show nextBillingFrequency attributes object
  
  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
  
  Additional properties are NOT allowed.
  
  Hide billingFrequency attribute Show billingFrequency attribute object
  
  name string | null
  
  The name of the enumeration.
- segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Additional properties are NOT allowed.
  
  Hide segment attribute Show segment attribute object
  
  name string | null
  
  The name of the enumeration.
- autoRenewEnabled boolean
  
  true if [automatic renew enabled]; otherwise, false.
- autoRenewSettings object
  
  Additional properties are NOT allowed.
  
  Hide autoRenewSettings attributes Show autoRenewSettings attributes object
  
  term object Required
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Additional properties are NOT allowed.
  
  Hide term attribute Show term attribute object
  
  name string | null
  
  The name of the enumeration.
  
  billingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Additional properties are NOT allowed.
  
  Hide billingFrequency attribute Show billingFrequency attribute object
  
  name string | null
  
  The name of the enumeration.
  
  quantity integer(int32) | null Required
  
  The quantity
  
  customTermEndDate string(date-time) | null
  
  The custom term end date
- margin object
  
  This value object contains the price margin for this entity.
  
  Additional properties are NOT allowed.
  
  Hide margin attributes Show margin attributes object
  
  marginRule object Required
  
  The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
  
  Additional properties are NOT allowed.
  
  Hide marginRule attribute Show marginRule attribute object
  
  name string | null
  
  The name of the enumeration.
  
  value number(double) | null Required
  
  The value applied to this price margin. Should not be below 0 or above 999.
- internalId string | null
  
  The internal identifier.
- poNumber string | null
  
  The po number.
- offer object
  
  View model that represents an Offer.
  
  Additional properties are NOT allowed.
  
  Hide offer attributes Show offer attributes object
  
  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.
  
  Additional properties are NOT allowed.
  
  Hide offerType attribute Show offerType attribute object
  
  name string | null
  
  The name of the enumeration.
  
  billingType object
  
  The billing type for the offer. Possible values: License, Usage or None
  
  Additional properties are NOT allowed.
  
  Hide billingType attribute Show billingType attribute object
  
  name string | null
  
  The name of the enumeration.
  
  prices array[object] | null
  
  The offer prices.
  
  Hide prices attributes Show prices attributes object
  
  termDuration object
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Additional properties are NOT allowed.
  
  Hide termDuration attribute Show termDuration attribute object
  
  name string | null
  
  The name of the enumeration.
  
  segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Additional properties are NOT allowed.
  
  Hide segment attribute Show segment attribute object
  
  name string | null
  
  The name of the enumeration.
  
  region object
  
  Additional properties are NOT allowed.
  
  Hide region attribute Show region attribute object
  
  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.
  
  billingFrequencies array[object] | null
  
  The offer price Billing Frequencies.
  
  Hide billingFrequencies attribute Show billingFrequencies attribute object
  
  name string | null
  
  The name of the enumeration.
  
  costPrice object
  
  Additional properties are NOT allowed.
  
  Hide costPrice attributes Show costPrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  revenuePrice object
  
  Additional properties are NOT allowed.
  
  Hide revenuePrice attributes Show revenuePrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  erpPrice object
  
  Additional properties are NOT allowed.
  
  Hide erpPrice attributes Show erpPrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  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.
- offerPrice object
  
  View model that represents an offer price.
  
  Additional properties are NOT allowed.
  
  Hide offerPrice attributes Show offerPrice attributes object
  
  termDuration object
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Additional properties are NOT allowed.
  
  Hide termDuration attribute Show termDuration attribute object
  
  name string | null
  
  The name of the enumeration.
  
  segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Additional properties are NOT allowed.
  
  Hide segment attribute Show segment attribute object
  
  name string | null
  
  The name of the enumeration.
  
  region object
  
  Additional properties are NOT allowed.
  
  Hide region attribute Show region attribute object
  
  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.
  
  billingFrequencies array[object] | null
  
  The offer price Billing Frequencies.
  
  Hide billingFrequencies attribute Show billingFrequencies attribute object
  
  name string | null
  
  The name of the enumeration.
  
  costPrice object
  
  Additional properties are NOT allowed.
  
  Hide costPrice attributes Show costPrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  revenuePrice object
  
  Additional properties are NOT allowed.
  
  Hide revenuePrice attributes Show revenuePrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  erpPrice object
  
  Additional properties are NOT allowed.
  
  Hide erpPrice attributes Show erpPrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
- providerData string | null
  
  The subscription provider data.
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
  
  Additional properties are NOT allowed.
  
  Hide status attribute Show status attribute object
  
  name string | null
  
  The name of the enumeration.
- 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
  
  Additional properties are NOT allowed.
  
  Hide termDuration attribute Show termDuration attribute object
  
  name string | null
  
  The name of the enumeration.
- billingFrequency object
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Additional properties are NOT allowed.
  
  Hide billingFrequency attribute Show billingFrequency attribute object
  
  name string | null
  
  The name of the enumeration.
- nextBillingFrequency object
  
  Additional properties are NOT allowed.
  
  Hide nextBillingFrequency attributes Show nextBillingFrequency attributes object
  
  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
  
  Additional properties are NOT allowed.
  
  Hide billingFrequency attribute Show billingFrequency attribute object
  
  name string | null
  
  The name of the enumeration.
- segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Additional properties are NOT allowed.
  
  Hide segment attribute Show segment attribute object
  
  name string | null
  
  The name of the enumeration.
- autoRenewEnabled boolean
  
  true if [automatic renew enabled]; otherwise, false.
- autoRenewSettings object
  
  Additional properties are NOT allowed.
  
  Hide autoRenewSettings attributes Show autoRenewSettings attributes object
  
  term object Required
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Additional properties are NOT allowed.
  
  Hide term attribute Show term attribute object
  
  name string | null
  
  The name of the enumeration.
  
  billingFrequency object Required
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  Additional properties are NOT allowed.
  
  Hide billingFrequency attribute Show billingFrequency attribute object
  
  name string | null
  
  The name of the enumeration.
  
  quantity integer(int32) | null Required
  
  The quantity
  
  customTermEndDate string(date-time) | null
  
  The custom term end date
- margin object
  
  This value object contains the price margin for this entity.
  
  Additional properties are NOT allowed.
  
  Hide margin attributes Show margin attributes object
  
  marginRule object Required
  
  The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
  
  Additional properties are NOT allowed.
  
  Hide marginRule attribute Show marginRule attribute object
  
  name string | null
  
  The name of the enumeration.
  
  value number(double) | null Required
  
  The value applied to this price margin. Should not be below 0 or above 999.
- internalId string | null
  
  The internal identifier.
- poNumber string | null
  
  The po number.
- offer object
  
  View model that represents an Offer.
  
  Additional properties are NOT allowed.
  
  Hide offer attributes Show offer attributes object
  
  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.
  
  Additional properties are NOT allowed.
  
  Hide offerType attribute Show offerType attribute object
  
  name string | null
  
  The name of the enumeration.
  
  billingType object
  
  The billing type for the offer. Possible values: License, Usage or None
  
  Additional properties are NOT allowed.
  
  Hide billingType attribute Show billingType attribute object
  
  name string | null
  
  The name of the enumeration.
  
  prices array[object] | null
  
  The offer prices.
  
  Hide prices attributes Show prices attributes object
  
  termDuration object
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Additional properties are NOT allowed.
  
  Hide termDuration attribute Show termDuration attribute object
  
  name string | null
  
  The name of the enumeration.
  
  segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Additional properties are NOT allowed.
  
  Hide segment attribute Show segment attribute object
  
  name string | null
  
  The name of the enumeration.
  
  region object
  
  Additional properties are NOT allowed.
  
  Hide region attribute Show region attribute object
  
  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.
  
  billingFrequencies array[object] | null
  
  The offer price Billing Frequencies.
  
  Hide billingFrequencies attribute Show billingFrequencies attribute object
  
  name string | null
  
  The name of the enumeration.
  
  costPrice object
  
  Additional properties are NOT allowed.
  
  Hide costPrice attributes Show costPrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  revenuePrice object
  
  Additional properties are NOT allowed.
  
  Hide revenuePrice attributes Show revenuePrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  erpPrice object
  
  Additional properties are NOT allowed.
  
  Hide erpPrice attributes Show erpPrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  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.
- offerPrice object
  
  View model that represents an offer price.
  
  Additional properties are NOT allowed.
  
  Hide offerPrice attributes Show offerPrice attributes object
  
  termDuration object
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Additional properties are NOT allowed.
  
  Hide termDuration attribute Show termDuration attribute object
  
  name string | null
  
  The name of the enumeration.
  
  segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Additional properties are NOT allowed.
  
  Hide segment attribute Show segment attribute object
  
  name string | null
  
  The name of the enumeration.
  
  region object
  
  Additional properties are NOT allowed.
  
  Hide region attribute Show region attribute object
  
  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.
  
  billingFrequencies array[object] | null
  
  The offer price Billing Frequencies.
  
  Hide billingFrequencies attribute Show billingFrequencies attribute object
  
  name string | null
  
  The name of the enumeration.
  
  costPrice object
  
  Additional properties are NOT allowed.
  
  Hide costPrice attributes Show costPrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  revenuePrice object
  
  Additional properties are NOT allowed.
  
  Hide revenuePrice attributes Show revenuePrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  erpPrice object
  
  Additional properties are NOT allowed.
  
  Hide erpPrice attributes Show erpPrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
- providerData string | null
  
  The subscription provider data.
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
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  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.
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
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  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.
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
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  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.
401

Unauthorized
403

Forbidden
500

text/plain

text/plain application/json text/json

Internal 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
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  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.
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
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  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.
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
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  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.

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

curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/customers/{customerId}/subscriptions/{subscriptionId} \
 -H "X-Tenant: portal.cloudcockpit.com" \
 -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": 8
  },
  "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": 8
  },
  "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"
      ]
    }
  ]
}