Billing API, REST: Customer.invite
Invites customer to the specified reseller.
HTTP request
POST https://billing.api.cloud.yandex.net/billing/v1/customers:invite
Body parameters
{
"resellerId": "string",
"name": "string",
"invitationEmail": "string",
"person": {
"name": "string",
"longname": "string",
"phone": "string",
"email": "string",
"postCode": "string",
"postAddress": "string",
"legalAddress": "string",
"tin": "string"
}
}
Field | Description |
---|---|
resellerId | string Required. Billing account ID of the reseller that the customer will be associated with. The maximum string length in characters is 50. |
name | string Required. Name of the customer. |
invitationEmail | string Required. Customer email to send invitation to. |
person | object Required. Person of the customer. Person of the customer. Contains legal information. |
person. name |
string Optional. Name of the person. String length is not limited. |
person. longname |
string Optional. Long name of the person. String length is not limited. |
person. phone |
string Optional. Phone of the person. Must be a valid telephone number or a valid phoneword. |
person. |
string Optional. Email of the person. Must be a valid email address. |
person. postCode |
string Optional. Post code of the person. String length is not limited. |
person. postAddress |
string Optional. Post address of the person. String length is not limited. |
person. legalAddress |
string Optional. Legal address of the person. String length is not limited. |
person. tin |
string Optional. Tax identification number of the person. String length is not limited. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
createdAt | string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
createdBy | string ID of the user or service account who initiated the operation. |
modifiedAt | string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
done | boolean (boolean) If the value is |
metadata | object Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
error | object The error result of the operation in case of failure or cancellation. includes only one of the fields error , response |
error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
error. message |
string An error message. |
error. details[] |
object A list of messages that carry the error details. |
response | object includes only one of the fields error , response The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. |