Query Billing Contact List

Query the list of billing contacts.

Request URL

GET {base_url}/user/openapi/user/v1/client/billing_contact_list

Request parameters

Headers


Parameter	Required	Description
User-Agent	Yes	Provide information about the user agent, such as the type of web browser, operating system, software version, etc., so as to help Yeastar Partner Portal to identify the user or the application that is making the request. Example: `User-Agent: OpenAPI`.
Authorization	Yes	Pass the access token in the header, so as to authenticate the API request. Format: Bearer `{access_token}`.

Query parameters

None.

Response parameters


Parameter	Type	Description
code	String	The response message of the API request.
detailMessage	String	The detailed error information. When the request is successful, this parameter returns empty.
requestId	String	The unique ID of the request, which can be used to quickly locate the request.
result	Object<Contact_Info>	The detailed information of the billing contact.
status	Integer	The HTTP status code of the API request.

Contact_Info


Parameter	Type	Description
billingContactId	String	The unique ID of the billing contact.
city	String	City.
company	String	Company.
country	String	Country.
emailAddress	String	Email address. When the billing contact is selected in an order, the invoice will be sent to this email address after successful payment.
firstName	String	First Name.
lastName	String	Last Name.
phoneNumber	String	Phone number.
remark	String	Remark.
stateProvince	String	State / Province.
street	String	Street.
taxNum	String	Tax identification number.
zipCode	String	ZIP / postal code.

Example

Request example

Query the list of billing contacts.

GET /user/openapi/user/v1/client/billing_contact_list HTTP/1.1
Host: openapi.partner.yeastar.com
User-Agent: OpenAPI
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsicmVzMSJdLCJYLU1TLVVTRVIiOiJ7XCJleHByXCI6XCIwXCIsXCJ0eXBlXCI6XCJwYXJ0bmVyXCIsXCJ1Y0lkXCI6XCIzMDc2OTEzNjQ0ODkwODMyODk2XCIsXCJ1c2VyQ29kZVwiOlwiRGlzdHJpYnV0b3JcIixcInVzZXJJZFwiOlwiMzA3NjkxMzY0NDkxNTk5ODcyMFwiLFwidXNlcm5hbWVcIjpcImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbVwifSIsInVzZXJfbmFtZSI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInNjb3BlIjpbImFsbCJdLCJleHAiOjE3Mzk1MzQzNDMsInRva2VuX3R5cGUiOiJvcGVuYXBpIiwiYXV0aG9yaXRpZXMiOlsiNzciXSwianRpIjoiKy9VV3pEbXRWOWRSejFMZVRzWFhIZktTQjU0PSIsImNsaWVudF9pZCI6ImFjMGYyZTViZWU3NmI2ZDdmNDU0NTY5NmMyNGZjMWYzIn0.Zx2HCuVFtJnSvs7UyY_d6EHCBNdrSK_v76ONI4GjCh0

Response example

{
    "code": "success",
    "detailMessage": "",
    "requestId": "b46f9371d2118e86e7b0083331e3c96e",
    "result": [
        {
            "billingContactId": "26606",
            "city": "Xiamen",
            "company": "ESI - Estech Systems, Inc",
            "country": "Italy",
            "emailAddress": "example1@outlook.com",
            "firstName": "DD",
            "lastName": "li",
            "phoneNumber": "13600930000",
            "remark": "",
            "stateProvince": "Fujian",
            "street": "3701 E Plano Pkwy",
            "taxNum": "VAT_number:123123",
            "zipCode": "75074"
        },
        {
            "billingContactId": "82956",
            "city": "Xiamen",
            "company": "Company Example",
            "country": "Hong Kong SAR, China",
            "emailAddress": "example1@yeastar.com",
            "firstName": "Example",
            "lastName": "li",
            "phoneNumber": "13600930000",
            "remark": "",
            "stateProvince": "Fujian",
            "street": "Siming",
            "taxNum": "VAT_number:123123",
            "zipCode": "361000"
        }
    ],
    "status": 200
}