Billing Subscriptions - List By Customer At Billing Account
Выводит список подписок для клиента на уровне учетной записи выставления счетов. Эта операция поддерживается только для учетных записей выставления счетов с типом соглашения Microsoft Partner Agreement.
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingSubscriptions?api-version=2024-04-01
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingSubscriptions?includeDeleted={includeDeleted}&api-version=2024-04-01&expand={expand}&filter={filter}&orderBy={orderBy}&top={top}&skip={skip}&count={count}&search={search}
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
billing
|
path | True |
string |
Идентификатор, который однозначно идентифицирует учетную запись выставления счетов. |
customer
|
path | True |
string |
Идентификатор, который однозначно идентифицирует клиента. |
api-version
|
query | True |
string |
Версия API, используемая с клиентским запросом. Текущая версия — 2024-04-01. |
count
|
query |
boolean |
Параметр запроса счетчика позволяет клиентам запрашивать количество соответствующих ресурсов, включенных в ответ. |
|
expand
|
query |
string |
Можно использовать для расширения |
|
filter
|
query |
string |
Параметр запроса фильтра позволяет клиентам фильтровать коллекцию ресурсов, адресованных URL-адресом запроса. |
|
include
|
query |
boolean |
Можно использовать для получения удаленных подписок выставления счетов. |
|
order
|
query |
string |
Параметр запроса orderby позволяет клиентам запрашивать ресурсы в определенном порядке. |
|
search
|
query |
string |
Параметр запроса поиска позволяет клиентам запрашивать элементы в коллекции, соответствующее выражению свободного текста. поиск поддерживается только для строковых полей. |
|
skip
|
query |
integer int64 |
Параметр пропуска запроса запрашивает количество элементов в запрашиваемой коллекции, которые должны быть пропущены и не включены в результат. |
|
top
|
query |
integer int64 |
Верхний параметр запроса запрашивает количество элементов в запрашиваемой коллекции, которые будут включены в результат. Максимальное поддерживаемое значение для верхней части — 50. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Список подписок выставления счетов. |
|
Other Status Codes |
Ответ на ошибку, описывающий причину сбоя операции. |
Примеры
BillingSubscriptionsListByCustomerAtBillingAccount
Образец запроса
Пример ответа
{
"value": [
{
"id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3",
"name": "6b96d3f2-9008-4a9d-912f-f87744185aa3",
"properties": {
"billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998",
"billingProfileDisplayName": "BillingProfile1",
"billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998",
"customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998/customers/Q7GV-UUVA-PJA-TGB",
"customerDisplayName": "Customer1",
"displayName": "My Subscription",
"reseller": {
"resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd",
"description": "Reseller1"
},
"skuId": "0002",
"skuDescription": "Microsoft Azure Standard",
"resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/6b96d3f2-9008-4a9d-912f-f87744185aa3",
"status": "Active",
"subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3"
},
"type": "Microsoft.Billing/billingAccounts/billingSubscriptions"
},
{
"id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12",
"name": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12",
"properties": {
"billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998",
"billingProfileDisplayName": "BillingProfile1",
"billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998",
"customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB",
"customerDisplayName": "Customer1",
"displayName": "Test Subscription",
"reseller": {
"resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19",
"description": "Reseller3"
},
"skuId": "0002",
"skuDescription": "Microsoft Azure Standard",
"resourceUri": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12",
"status": "Active",
"subscriptionId": "CD0BBD7A-461A-4D9A-9C59-EAE51A0D5D12"
},
"type": "Microsoft.Billing/billingAccounts/billingSubscriptions"
},
{
"id": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32",
"name": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32",
"properties": {
"billingProfileId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/billingProfiles/ea36e548-1505-41db-bebc-46fff3d37998",
"billingProfileDisplayName": "BillingProfile1",
"billingProfileName": "ea36e548-1505-41db-bebc-46fff3d37998",
"customerId": "/providers/Microsoft.Billing/billingAccounts/a1a9c77e-4cec-4a6c-a089-867d973a6074:a80d3b1f-c626-4e5e-82ed-1173bd91c838_2019-05-31/customers/Q7GV-UUVA-PJA-TGB",
"customerDisplayName": "Customer1",
"displayName": "Dev Test Subscription",
"skuId": "0001",
"skuDescription": "Domain Name Registration ORG",
"resourceUri": "/providers/Microsoft.Domain/domainSubscriptions/9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32",
"status": "Active",
"subscriptionId": "9e90f86b-22fc-42f3-bfe2-0ac3e7c01d32"
},
"type": "Microsoft.Billing/billingAccounts/billingSubscriptions"
}
]
}
Определения
Имя | Описание |
---|---|
Amount |
Сумма. |
Auto |
Указывает, включена ли автоматическая продление продукта или отключена. |
Beneficiary |
Сведения о бенефициаре. |
Billing |
Свойства выставления счетов подписки. |
Billing |
Контейнер для списка ресурсов |
Billing |
Состояние операции в подписке. Если нет, не существует текущей операции. При блокировке LockedForUpdate операции записи будут заблокированы в подписке выставления счетов. Другой — это значение по умолчанию, и вам может потребоваться обратиться к последней версии API для получения дополнительных сведений. |
Billing |
Состояние подписки. Это поле недоступно для учетных записей выставления счетов соглашения Enterprise |
Billing |
Сведения о приостановке подписки. Это поле недоступно для учетных записей выставления счетов соглашения Enterprise. |
Cancellation |
Переопределение политики для подписки указывает, разрешено ли самостоятельное отмена или сокращение мест. |
created |
Тип удостоверения, создавшего ресурс. |
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Ответ на ошибку |
Next |
Сведения о цикле выставления счетов продукта. |
Provisioning |
Состояние подготовки ресурса во время длительной операции. |
Renewal |
Сведения о следующем сроке продления подписки. |
Reseller |
Сведения о торговом посреднике. |
Subscription |
Текущее состояние учетной записи регистрации подписки. Это поле доступно только для типа соглашения Enterprise. |
Subscription |
Причина приостановки подписки. Это поле недоступно для учетных записей выставления счетов соглашения Enterprise. |
system |
Метаданные, относящиеся к созданию и последнему изменении ресурса. |
System |
Системные политики, которые регулируют поведение подписки. |
Amount
Сумма.
Имя | Тип | Описание |
---|---|---|
currency |
string |
Валюта для значения суммы. |
value |
number |
Значение суммы. Например, если валюта — USD, то значение 600 будет $600,00. |
AutoRenew
Указывает, включена ли автоматическая продление продукта или отключена.
Имя | Тип | Описание |
---|---|---|
Off |
string |
|
On |
string |
Beneficiary
Сведения о бенефициаре.
Имя | Тип | Описание |
---|---|---|
objectId |
string |
Идентификатор, который однозначно идентифицирует пользователя в клиенте. |
tenantId |
string |
Идентификатор, который однозначно идентифицирует клиент. |
BillingSubscription
Свойства выставления счетов подписки.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
Имя ресурса |
properties.autoRenew |
Указывает, включена ли автоматическая продление продукта или отключена. |
|
properties.beneficiary |
Бенефициар подписки на выставление счетов. |
|
properties.beneficiaryTenantId |
string |
Клиент подготовки подписки. |
properties.billingFrequency |
string |
Частота выставления счетов в ISO8601 формате продукта в подписке. Пример: P1M, P3M, P1Y |
properties.billingPolicies |
object |
Словарь политик выставления счетов, связанных с подпиской. |
properties.billingProfileDisplayName |
string |
Имя профиля выставления счетов. |
properties.billingProfileId |
string |
Полный идентификатор, который однозначно идентифицирует профиль выставления счетов. |
properties.billingProfileName |
string |
Идентификатор, который однозначно идентифицирует профиль выставления счетов. |
properties.consumptionCostCenter |
string |
Центр затрат, применяемый к подписке. Это поле доступно только для подписок на использование учетных записей выставления счетов клиентского соглашения Майкрософт или типа соглашения Enterprise. |
properties.customerDisplayName |
string |
Имя клиента. |
properties.customerId |
string |
Полный идентификатор, который однозначно идентифицирует клиента. |
properties.customerName |
string |
Идентификатор, который однозначно идентифицирует клиента. |
properties.displayName |
string |
Имя подписки на выставление счетов. |
properties.enrollmentAccountDisplayName |
string |
Имя учетной записи регистрации, связанное с подпиской. Это поле доступно только для учетных записей выставления счетов типа соглашения Enterprise. |
properties.enrollmentAccountId |
string |
Идентификатор учетной записи регистрации, связанный с подпиской. Это поле доступно только для учетных записей выставления счетов типа соглашения Enterprise. |
properties.enrollmentAccountSubscriptionDetails.enrollmentAccountStartDate |
string |
Учетная запись регистрации и дата начала сопоставления подписок. Это поле доступно только для типа соглашения Enterprise. |
properties.enrollmentAccountSubscriptionDetails.subscriptionEnrollmentAccountStatus |
Текущее состояние учетной записи регистрации подписки. Это поле доступно только для типа соглашения Enterprise. |
|
properties.invoiceSectionDisplayName |
string |
Имя раздела счета. |
properties.invoiceSectionId |
string |
Полный идентификатор, который однозначно идентифицирует раздел счета. |
properties.invoiceSectionName |
string |
Идентификатор, который однозначно идентифицирует раздел счета. |
properties.lastMonthCharges |
Расходы за прошлый месяц. Это поле доступно только для подписок на основе использования учетных записей выставления счетов клиентского соглашения Майкрософт. |
|
properties.monthToDateCharges |
Текущие платежи за текущий месяц до даты. Это поле доступно только для подписок на основе использования учетных записей выставления счетов клиентского соглашения Майкрософт. |
|
properties.nextBillingCycleDetails |
Дальнейшие сведения о цикле выставления счетов подписки. |
|
properties.offerId |
string |
Идентификатор предложения для подписки. Это поле доступно только для учетных записей выставления счетов программы Microsoft Online Services. |
properties.operationStatus |
Состояние операции в подписке. Если нет, не существует текущей операции. При блокировке LockedForUpdate операции записи будут заблокированы в подписке выставления счетов. Другой — это значение по умолчанию, и вам может потребоваться обратиться к последней версии API для получения дополнительных сведений. |
|
properties.productCategory |
string |
Категория продукта, для которого приобретена подписка. Возможные значения: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. |
properties.productType |
string |
Тип продукта, для которого приобретена подписка. |
properties.productTypeId |
string |
Идентификатор продукта, для которого приобретена подписка. |
properties.provisioningState |
Состояние подготовки ресурса во время длительной операции. |
|
properties.provisioningTenantId |
string |
Клиент, в котором подготовлена подписка. |
properties.purchaseDate |
string |
Дата покупки продукта в формате UTC. |
properties.quantity |
integer |
Количество лицензий или единиц выполнения для подписки. |
properties.renewalTermDetails |
Сведения о следующем сроке продления подписки. |
|
properties.reseller |
Торговый посредник для этой подписки. Поля недоступны для учетных записей выставления счетов соглашения с партнером Майкрософт. |
|
properties.resourceUri |
string |
Уникальный идентификатор связанного ресурса. |
properties.skuDescription |
string |
Описание номера SKU продукта, для которого приобретена подписка. Это поле доступно только для учетных записей выставления счетов с типом клиентского соглашения Майкрософт и соглашением с партнером Майкрософт. |
properties.skuId |
string |
Идентификатор SKU продукта, для которого приобретена подписка. Это поле доступно только для учетных записей выставления счетов клиентского соглашения Майкрософт. |
properties.status |
Состояние подписки. Это поле недоступно для учетных записей выставления счетов соглашения Enterprise |
|
properties.subscriptionId |
string |
Идентификатор подписки. |
properties.suspensionReasonDetails |
Сведения о приостановке подписки. Это поле недоступно для учетных записей выставления счетов соглашения Enterprise. |
|
properties.suspensionReasons |
string[] |
Причина приостановки подписки. Это поле недоступно для учетных записей выставления счетов соглашения Enterprise. |
properties.systemOverrides |
Системные политики, которые регулируют поведение подписки. |
|
properties.termDuration |
string |
Длительность в ISO8601 формате, для которого можно использовать подписку. Пример: P1M, P3M, P1Y |
properties.termEndDate |
string |
Дата окончания термина в формате UTC. |
properties.termStartDate |
string |
Дата начала термина в формате UTC. |
systemData |
Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy. |
|
tags |
object |
Словарь метаданных, связанных с ресурсом. Он не может быть заполнен для всех типов ресурсов. Максимальная длина ключа и значения, поддерживаемая 256 символами. Ключи или значение не должны пустыми значениями и значениями NULL. Ключи не могут содержать <> % & \ ? / |
type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
BillingSubscriptionListResult
Контейнер для списка ресурсов
Имя | Тип | Описание |
---|---|---|
nextLink |
string |
Ссылка (URL-адрес) на следующую страницу результатов. |
totalCount |
number |
Общее количество записей. |
value |
Список ресурсов. |
BillingSubscriptionOperationStatus
Состояние операции в подписке. Если нет, не существует текущей операции. При блокировке LockedForUpdate операции записи будут заблокированы в подписке выставления счетов. Другой — это значение по умолчанию, и вам может потребоваться обратиться к последней версии API для получения дополнительных сведений.
Имя | Тип | Описание |
---|---|---|
LockedForUpdate |
string |
|
None |
string |
|
Other |
string |
BillingSubscriptionStatus
Состояние подписки. Это поле недоступно для учетных записей выставления счетов соглашения Enterprise
Имя | Тип | Описание |
---|---|---|
Active |
string |
|
AutoRenew |
string |
|
Cancelled |
string |
|
Deleted |
string |
|
Disabled |
string |
|
Expired |
string |
|
Expiring |
string |
|
Failed |
string |
|
Other |
string |
|
Suspended |
string |
|
Unknown |
string |
|
Warned |
string |
BillingSubscriptionStatusDetails
Сведения о приостановке подписки. Это поле недоступно для учетных записей выставления счетов соглашения Enterprise.
Имя | Тип | Описание |
---|---|---|
effectiveDate |
string |
Дата действия приостановки подписки. Это поле недоступно для учетных записей выставления счетов соглашения Enterprise. |
reason |
Причина приостановки подписки. Это поле недоступно для учетных записей выставления счетов соглашения Enterprise. |
Cancellation
Переопределение политики для подписки указывает, разрешено ли самостоятельное отмена или сокращение мест.
Имя | Тип | Описание |
---|---|---|
Allowed |
string |
|
NotAllowed |
string |
createdByType
Тип удостоверения, создавшего ресурс.
Имя | Тип | Описание |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Ответ на ошибку
Имя | Тип | Описание |
---|---|---|
error |
Объект ошибки. |
NextBillingCycleDetails
Сведения о цикле выставления счетов продукта.
Имя | Тип | Описание |
---|---|---|
billingFrequency |
string |
Частота выставления счетов продукта в подписке. |
ProvisioningState
Состояние подготовки ресурса во время длительной операции.
Имя | Тип | Описание |
---|---|---|
Canceled |
string |
|
Failed |
string |
|
New |
string |
|
Pending |
string |
|
Provisioning |
string |
|
Succeeded |
string |
RenewalTermDetails
Сведения о следующем сроке продления подписки.
Имя | Тип | Описание |
---|---|---|
billingFrequency |
string |
Частота выставления счетов в ISO8601 формате продукта в подписке. Пример: P1M, P3M, P1Y |
productId |
string |
Идентификатор продукта, для которого приобретена подписка. |
productTypeId |
string |
Идентификатор типа продукта, для которого приобретена подписка. |
quantity |
integer |
Количество лицензий или единиц выполнения для подписки. |
skuId |
string |
Идентификатор SKU продукта, для которого приобретена подписка. Это поле доступно только для учетных записей выставления счетов клиентского соглашения Майкрософт. |
termDuration |
string |
Длительность в ISO8601 формате, для которого можно использовать подписку. Пример: P1M, P3M, P1Y |
termEndDate |
string |
Дата окончания термина в формате UTC. |
Reseller
Сведения о торговом посреднике.
Имя | Тип | Описание |
---|---|---|
description |
string |
Имя торгового посредника. |
resellerId |
string |
Идентификатор MPN торгового посредника. |
SubscriptionEnrollmentAccountStatus
Текущее состояние учетной записи регистрации подписки. Это поле доступно только для типа соглашения Enterprise.
Имя | Тип | Описание |
---|---|---|
Active |
string |
|
Cancelled |
string |
|
Deleted |
string |
|
Expired |
string |
|
Inactive |
string |
|
TransferredOut |
string |
|
Transferring |
string |
SubscriptionStatusReason
Причина приостановки подписки. Это поле недоступно для учетных записей выставления счетов соглашения Enterprise.
Имя | Тип | Описание |
---|---|---|
Cancelled |
string |
|
Expired |
string |
|
None |
string |
|
Other |
string |
|
PastDue |
string |
|
PolicyViolation |
string |
|
SpendingLimitReached |
string |
|
SuspiciousActivity |
string |
|
Transferred |
string |
systemData
Метаданные, относящиеся к созданию и последнему изменении ресурса.
Имя | Тип | Описание |
---|---|---|
createdAt |
string |
Метка времени создания ресурса (UTC). |
createdBy |
string |
Удостоверение, создающее ресурс. |
createdByType |
Тип удостоверения, создавшего ресурс. |
|
lastModifiedAt |
string |
Метка времени последнего изменения ресурса (UTC) |
lastModifiedBy |
string |
Идентификатор, который последний раз изменил ресурс. |
lastModifiedByType |
Тип удостоверения, который последний раз изменил ресурс. |
SystemOverrides
Системные политики, которые регулируют поведение подписки.
Имя | Тип | Описание |
---|---|---|
cancellation |
Переопределение политики для подписки указывает, разрешено ли самостоятельное отмена или сокращение мест. |
|
cancellationAllowedEndDate |
string |
Дата окончания в формате UTC по окончании самостоятельной отмены. |