Billing Accounts - Add Payment Terms

服务:

Billing

API 版本:

2024-04-01

向计费帐户下的所有计费配置文件添加付款条款。 目前，只能在协议类型为“Microsoft客户协议”和 AccountType 为“Enterprise”的计费帐户上添加付款条款。 此操作需要预先授权，只有 Field Sellers 才有权添加付款条款，并且不是自助服务操作。

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/addPaymentTerms?api-version=2024-04-01

URI 参数

名称	在	必需	类型	说明
billingAccountName	path	True	string pattern: ^([0-9]+|([Pp][Cc][Nn]\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$	唯一标识计费帐户的 ID。
api-version	query	True	string	要用于客户端请求的 API 的版本。 当前版本为 2024-04-01。

请求正文

名称	类型	说明
parameters	PaymentTerm[]	付款期限的属性。

响应

名称	类型	说明
200 OK	BillingAccount	计费帐户列表。
202 Accepted		一个操作接受的结果，该结果返回客户端可以轮询以查看操作结果的“Location”标头。 标头 Location: string Retry-After: integer
Other Status Codes	ErrorResponse	描述操作失败的原因的错误响应。

示例

PaymentTermsAdd

示例请求

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/addPaymentTerms?api-version=2024-04-01

[
  {
    "term": "net10",
    "startDate": "2023-01-05T22:39:34.2606750Z",
    "endDate": "2023-01-25T22:39:34.2606750Z"
  }
]

Java

import com.azure.resourcemanager.billing.models.PaymentTerm;
import java.time.OffsetDateTime;
import java.util.Arrays;

/**
 * Samples for BillingAccounts AddPaymentTerms.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermsAdd.json
     */
    /**
     * Sample code: PaymentTermsAdd.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void paymentTermsAdd(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingAccounts()
            .addPaymentTerms("00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
                Arrays.asList(new PaymentTerm().withTerm("net10")
                    .withStartDate(OffsetDateTime.parse("2023-01-05T22:39:34.2606750Z"))
                    .withEndDate(OffsetDateTime.parse("2023-01-25T22:39:34.2606750Z"))),
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python payment_terms_add.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BillingManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.billing_accounts.begin_add_payment_terms(
        billing_account_name="00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        parameters=[
            {"endDate": "2023-01-25T22:39:34.2606750Z", "startDate": "2023-01-05T22:39:34.2606750Z", "term": "net10"}
        ],
    ).result()
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermsAdd.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armbilling_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/billing/armbilling"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c08ac9813477921ad8295b98ced8f82d11b8f913/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermsAdd.json
func ExampleAccountsClient_BeginAddPaymentTerms() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbilling.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAccountsClient().BeginAddPaymentTerms(ctx, "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", []*armbilling.PaymentTerm{
		{
			EndDate:   to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-25T22:39:34.260Z"); return t }()),
			StartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-05T22:39:34.260Z"); return t }()),
			Term:      to.Ptr("net10"),
		}}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armbilling.Account{
	// 	Name: to.Ptr("00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/010000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
	// 	SystemData: &armbilling.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-04T22:39:34.260Z"); return t}()),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-05T22:39:34.260Z"); return t}()),
	// 	},
	// 	Properties: &armbilling.AccountProperties{
	// 		AccountStatus: to.Ptr(armbilling.AccountStatusActive),
	// 		AccountSubType: to.Ptr(armbilling.AccountSubTypeEnterprise),
	// 		AccountType: to.Ptr(armbilling.AccountTypeBusiness),
	// 		AgreementType: to.Ptr(armbilling.AgreementTypeMicrosoftCustomerAgreement),
	// 		DisplayName: to.Ptr("Premier Business Account"),
	// 		HasReadAccess: to.Ptr(true),
	// 		PrimaryBillingTenantID: to.Ptr("20000000-0000-0000-0000-000000000001"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Adds payment terms to all the billing profiles under the billing account. Currently, payment terms can be added only on billing accounts that have Agreement Type as 'Microsoft Customer Agreement' and AccountType as 'Enterprise'. This action needs pre-authorization and only Field Sellers are authorized to add the payment terms and is not a self-serve action.
 *
 * @summary Adds payment terms to all the billing profiles under the billing account. Currently, payment terms can be added only on billing accounts that have Agreement Type as 'Microsoft Customer Agreement' and AccountType as 'Enterprise'. This action needs pre-authorization and only Field Sellers are authorized to add the payment terms and is not a self-serve action.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermsAdd.json
 */
async function paymentTermsAdd() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
  const parameters = [
    {
      endDate: new Date("2023-01-25T22:39:34.2606750Z"),
      startDate: new Date("2023-01-05T22:39:34.2606750Z"),
      term: "net10",
    },
  ];
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.billingAccounts.beginAddPaymentTermsAndWait(
    billingAccountName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Billing.Models;
using Azure.ResourceManager.Billing;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermsAdd.json
// this example is just showing the usage of "BillingAccounts_AddPaymentTerms" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BillingAccountResource created on azure
// for more information of creating BillingAccountResource, please refer to the document of BillingAccountResource
string billingAccountName = "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
ResourceIdentifier billingAccountResourceId = BillingAccountResource.CreateResourceIdentifier(billingAccountName);
BillingAccountResource billingAccount = client.GetBillingAccountResource(billingAccountResourceId);

// invoke the operation
IEnumerable<BillingPaymentTerm> arrayOfPaymentTerm = new BillingPaymentTerm[]
{
new BillingPaymentTerm
{
Term = "net10",
StartOn = DateTimeOffset.Parse("2023-01-05T22:39:34.2606750Z"),
EndOn = DateTimeOffset.Parse("2023-01-25T22:39:34.2606750Z"),
}
};
ArmOperation<BillingAccountResource> lro = await billingAccount.AddPaymentTermsAsync(WaitUntil.Completed, arrayOfPaymentTerm);
BillingAccountResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
BillingAccountData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

202

location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2018-09-30/operationResults/addPaymentTerms_ed2975a8-8f77-43bb-a717-ace54326b14b?api-version=2024-04-01
retry-after: 10
operation-id: ed2975a8-8f77-43bb-a717-ace54326b14b

状态代码:

200

{
  "id": "/providers/Microsoft.Billing/billingAccounts/010000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
  "name": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
  "properties": {
    "accountStatus": "Active",
    "accountType": "Business",
    "accountSubType": "Enterprise",
    "agreementType": "MicrosoftCustomerAgreement",
    "displayName": "Premier Business Account",
    "hasReadAccess": true,
    "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001"
  },
  "type": "Microsoft.Billing/billingAccounts",
  "systemData": {
    "createdAt": "2023-01-04T22:39:34.2606750Z",
    "lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
  }
}

定义

名称	说明
AccountStatus	计费帐户的当前状态。
AccountSubType	帐户的层。
AccountType	客户的类型。
AgreementType	协议的类型。
BillingAccount	计费帐户。
BillingAccountProperties	计费帐户。
BillingAccountStatusReasonCode	指定计费帐户状态的原因。
BillingRelationshipType	标识计费帐户表示的计费关系。 计费关系可能介于Microsoft、客户和第三方之间。
createdByType	创建资源的标识的类型。
EnrollmentDetails	注册的属性。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ExtendedTermOption	公司选择的计费帐户扩展。
IndirectRelationshipInfo	标识与间接购买运动中的另一个计费配置文件关联的计费配置文件。
MarkupStatus	注册的标记状态，仅适用于间接注册。
PaymentTerm	付款期限的属性。
ProvisioningState	长时间运行的操作期间资源的预配状态。
RegistrationNumber	描述与计费帐户关联的组织的注册号。
SoldTo	负责计费帐户的个人或组织的地址。
SupportLevel	与注册关联的支持级别产品/服务。
systemData	与创建和上次修改资源相关的元数据。
TaxIdentifier	计费帐户的税务标识符。
TaxIdentifierStatus	税务标识符的状态。
TaxIdentifierType	税务标识符的类型。

AccountStatus

枚举

计费帐户的当前状态。

值	说明
Active
Deleted
Disabled
Expired
Extended
New
Other
Pending
Terminated
Transferred
UnderReview

AccountSubType

枚举

帐户的层。

值	说明
Enterprise
Individual
None
Other
Professional

AccountType

枚举

客户的类型。

值	说明
Business
ClassicPartner
Enterprise
Individual
Internal
Other
Partner
Reseller
Tenant

AgreementType

枚举

协议的类型。

值	说明
EnterpriseAgreement
MicrosoftCustomerAgreement
MicrosoftOnlineServicesProgram
MicrosoftPartnerAgreement
Other

BillingAccount

Object

计费帐户。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties	BillingAccountProperties	计费帐户。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	与资源关联的元数据字典。 它可能不会针对所有资源类型进行填充。 支持的最大键/值长度为 256 个字符。 键/值不应为空值，也不应为 null。 键不能包含 <> % & \ ？ /
type	string	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

BillingAccountProperties

Object

计费帐户。

名称	类型	说明
accountStatus	AccountStatus	计费帐户的当前状态。
accountStatusReasonCode	BillingAccountStatusReasonCode	指定计费帐户状态的原因。
accountSubType	AccountSubType	帐户的层。
accountType	AccountType	客户的类型。
agreementType	AgreementType	协议的类型。
billingRelationshipTypes	BillingRelationshipType[]	标识计费帐户表示的计费关系。 计费关系可能介于Microsoft、客户和第三方之间。
displayName	string	计费帐户名称。
enrollmentDetails	EnrollmentDetails	注册的属性。
hasNoBillingProfiles	boolean	指示计费帐户是否具有任何计费配置文件。
hasReadAccess	boolean	指示用户是否具有对计费帐户的读取访问权限。
notificationEmailAddress	string	旧帐户的通知电子邮件地址。 可用于联机服务计划Microsoft协议类型。
primaryBillingTenantId	string	用于设置计费帐户的租户。 默认情况下，只有来自此租户的用户才能在计费帐户上获取角色分配，并且此租户中预配了所有购买。
provisioningState	ProvisioningState	长时间运行的操作期间资源的预配状态。
qualifications	string[]	计费帐户定价的资格。 价值可以是商业、教育、慈善或政府。
registrationNumber	RegistrationNumber	描述与计费帐户关联的组织的注册号。
soldTo	SoldTo	负责计费帐户的个人或组织的地址。
taxIds	TaxIdentifier[]	计费帐户的税务标识符列表。

BillingAccountStatusReasonCode

枚举

指定计费帐户状态的原因。

值	说明
Expired
ManuallyTerminated
Other
TerminateProcessing
Transferred
UnusualActivity

BillingRelationshipType

枚举

标识计费帐户表示的计费关系。 计费关系可能介于Microsoft、客户和第三方之间。

值	说明
CSPCustomer
CSPPartner
Direct
IndirectCustomer
IndirectPartner
Other

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

EnrollmentDetails

Object

注册的属性。

名称	类型	说明
billingCycle	string	注册的计费周期。
channel	string	注册的通道类型。
cloud	string	注册的云。
countryCode	string	注册的国家/地区代码。
currency	string	注册的计费货币。
endDate	string (date-time)	注册的结束日期。
extendedTermOption	ExtendedTermOption	公司选择的计费帐户扩展。
indirectRelationshipInfo	IndirectRelationshipInfo	仅适用于间接注册的注册的属性。
invoiceRecipient	string	接收注册发票的联系人。
language	string	注册的语言。
markupStatus	MarkupStatus	注册的标记状态，仅适用于间接注册。
poNumber	string	注册的采购订单号。
startDate	string (date-time)	注册的开始日期。
supportCoverage	string	注册的支持覆盖期。
supportLevel	SupportLevel	与注册关联的支持级别产品/服务。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ExtendedTermOption

枚举

公司选择的计费帐户扩展。

值	说明
Opted-In
Opted-Out
Other

IndirectRelationshipInfo

Object

标识与间接购买运动中的另一个计费配置文件关联的计费配置文件。

名称	类型	说明
billingAccountName	string	用于间接运动的合作伙伴或客户的计费帐户名称。
billingProfileName	string	合作伙伴或客户的计费配置文件名称，用于间接动议。
displayName	string	间接运动的合作伙伴或客户的显示名称。

MarkupStatus

枚举

注册的标记状态，仅适用于间接注册。

值	说明
Disabled
Locked
Other
Preview
Published

PaymentTerm

Object

付款期限的属性。

名称	类型	说明
endDate	string (date-time)	定义的“付款期限”将结束且始终采用 UTC 的日期。
isDefault	boolean	指示付款期限是标准付款期限。
startDate	string (date-time)	定义的“付款期限”生效的日期，并且始终采用 UTC 格式。
term	string	表示 netXX 格式的持续时间。 始终以天为单位。

ProvisioningState

枚举

长时间运行的操作期间资源的预配状态。

值	说明
Canceled
Failed
New
Pending
Provisioning
Succeeded

RegistrationNumber

Object

描述与计费帐户关联的组织的注册号。

名称	类型	说明
id	string	与计费帐户关联的组织的唯一标识号。
required	boolean	标识计费帐户是否需要注册号。
type	string[]	根据计费帐户的国家/地区允许的注册号类型。

SoldTo

Object

负责计费帐户的个人或组织的地址。

名称	类型	说明
addressLine1	string minLength: 1	地址行 1。
addressLine2	string	地址行 2。
addressLine3	string	地址行 3。
city	string	地址城市。
companyName	string	公司名称。 MCA 个人版（即用即付）可选。
country	string minLength: 1	国家/地区代码使用 ISO 3166-1 Alpha-2 格式。
district	string	地址区域。
email	string	电子邮件地址。
firstName	string	名字。 MCA Enterprise 可选。
isValidAddress	boolean	指示地址是否不完整。
lastName	string	姓。 MCA Enterprise 可选。
middleName	string	中间名称。
phoneNumber	string	电话号码。
postalCode	string	邮政编码。
region	string	地址区域。

SupportLevel

枚举

与注册关联的支持级别产品/服务。

值	说明
Developer
Other
Pro-Direct
Standard

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

TaxIdentifier

Object

计费帐户的税务标识符。

名称	类型	说明
country	string	税务标识符的国家/地区。
id	string	税务标识符的 ID。
scope	string	税务标识符的范围。
status	TaxIdentifierStatus	税务标识符的状态。
type	TaxIdentifierType	税务标识符的类型。

TaxIdentifierStatus

枚举

税务标识符的状态。

值	说明
Invalid
Other
Valid

TaxIdentifierType

枚举

税务标识符的类型。

值	说明
BrazilCcmId
BrazilCnpjId
BrazilCpfId
CanadianFederalExempt
CanadianProvinceExempt
ExternalTaxation
IndiaFederalServiceTaxId
IndiaFederalTanId
IndiaPanId
IndiaStateCstId
IndiaStateGstINId
IndiaStateVatId
IntlExempt
LoveCode
MobileBarCode
NationalIdentificationNumber
Other
PublicSectorId
USExempt
VatId