class AccountsCustomersCustomerRepricingConfigs extends Resource (View source)

The "customerRepricingConfigs" collection of methods.

Typical usage is:

 $cloudchannelService = new Google\Service\Cloudchannel(...);
 $customerRepricingConfigs = $cloudchannelService->accounts_customers_customerRepricingConfigs;

Methods

create(string $parent, GoogleCloudChannelV1CustomerRepricingConfig $postBody, array $optParams = [])

Creates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. You can only create configs if the RepricingConfig.effective_invoice_month is a future month. If needed, you can create a config for the current month, with some restrictions. When creating a config for a future month, make sure there are no existing configs for that RepricingConfig.effective_invoice_month. The following restrictions are for creating configs in the current month. This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases. The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.

delete(string $name, array $optParams = [])

Deletes the given CustomerRepricingConfig permanently. You can only delete configs if their RepricingConfig.effective_invoice_month is set to a date after the current month. Possible error codes: PERMISSION_DENIED: The account making the request does not own this customer. INVALID_ARGUMENT: Required request parameters are missing or invalid. FAILED_PRECONDITION: The CustomerRepricingConfig is active or in the past. NOT_FOUND: No CustomerRepricingConfig found for the name in the request.

get(string $name, array $optParams = [])

Gets information about how a Reseller modifies their bill before sending it to a Customer. Possible Error Codes: PERMISSION_DENIED: If the account making the request and the account being queried are different. NOT_FOUND: The CustomerRepricingConfig was not found. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the CustomerRepricingConfig resource, otherwise returns an error. (customerRepricingConfigs.get)

listAccountsCustomersCustomerRepricingConfigs(string $parent, array $optParams = [])

Lists information about how a Reseller modifies their bill before sending it to a Customer. Possible Error Codes: PERMISSION_DENIED: If the account making the request and the account being queried are different. NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account. INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the CustomerRepricingConfig resources. The data for each resource is displayed in the ascending order of: Customer ID RepricingConfig.EntitlementGranularity.entitlement RepricingConfig.effective_invoice_month * CustomerRepricingConfig.update_time If unsuccessful, returns an error.

patch(string $name, GoogleCloudChannelV1CustomerRepricingConfig $postBody, array $optParams = [])

Updates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. This method overwrites the existing CustomerRepricingConfig. You can only update configs if the RepricingConfig.effective_invoice_month is a future month. To make changes to configs for the current month, use CreateCustomerRepricingConfig, taking note of its restrictions. You cannot update the RepricingConfig.effective_invoice_month. When updating a config in the future: This config must already exist. Possible Error Codes: PERMISSION_DENIED: If the account making the request and the account being queried are different. INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated CustomerRepricingConfig resource, otherwise returns an error.

Details

GoogleCloudChannelV1CustomerRepricingConfig create(string $parent, GoogleCloudChannelV1CustomerRepricingConfig $postBody, array $optParams = [])

Creates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. You can only create configs if the RepricingConfig.effective_invoice_month is a future month. If needed, you can create a config for the current month, with some restrictions. When creating a config for a future month, make sure there are no existing configs for that RepricingConfig.effective_invoice_month. The following restrictions are for creating configs in the current month. This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases. The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.

  • There is a limit of ten configs for any RepricingConfig.EntitlementGranularity.entitlement, for any RepricingConfig.effective_invoice_month. The contained CustomerRepricingConfig.repricing_config value must be different from the value used in the current config for a RepricingConfig.EntitlementGranularity.entitlement. Possible Error Codes: PERMISSION_DENIED: If the account making the request and the account being queried are different. INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated CustomerRepricingConfig resource, otherwise returns an error. (customerRepricingConfigs.create)

Parameters

string $parent

Required. The resource name of the customer that will receive this repricing config. Parent uses the format: accounts/{account_id}/customers/{customer_id}

GoogleCloudChannelV1CustomerRepricingConfig $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudChannelV1CustomerRepricingConfig

Exceptions

Exception

GoogleProtobufEmpty delete(string $name, array $optParams = [])

Deletes the given CustomerRepricingConfig permanently. You can only delete configs if their RepricingConfig.effective_invoice_month is set to a date after the current month. Possible error codes: PERMISSION_DENIED: The account making the request does not own this customer. INVALID_ARGUMENT: Required request parameters are missing or invalid. FAILED_PRECONDITION: The CustomerRepricingConfig is active or in the past. NOT_FOUND: No CustomerRepricingConfig found for the name in the request.

(customerRepricingConfigs.delete)

Parameters

string $name

Required. The resource name of the customer repricing config rule to delete. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.

array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleCloudChannelV1CustomerRepricingConfig get(string $name, array $optParams = [])

Gets information about how a Reseller modifies their bill before sending it to a Customer. Possible Error Codes: PERMISSION_DENIED: If the account making the request and the account being queried are different. NOT_FOUND: The CustomerRepricingConfig was not found. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the CustomerRepricingConfig resource, otherwise returns an error. (customerRepricingConfigs.get)

Parameters

string $name

Required. The resource name of the CustomerRepricingConfig. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.

array $optParams

Optional parameters.

Return Value

GoogleCloudChannelV1CustomerRepricingConfig

Exceptions

Exception

GoogleCloudChannelV1ListCustomerRepricingConfigsResponse listAccountsCustomersCustomerRepricingConfigs(string $parent, array $optParams = [])

Lists information about how a Reseller modifies their bill before sending it to a Customer. Possible Error Codes: PERMISSION_DENIED: If the account making the request and the account being queried are different. NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account. INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the CustomerRepricingConfig resources. The data for each resource is displayed in the ascending order of: Customer ID RepricingConfig.EntitlementGranularity.entitlement RepricingConfig.effective_invoice_month * CustomerRepricingConfig.update_time If unsuccessful, returns an error.

(customerRepricingConfigs.listAccountsCustomersCustomerRepricingConfigs)

Parameters

string $parent

Required. The resource name of the customer. Parent uses the format: accounts/{account_id}/customers/{customer_id}. Supports accounts/{account_id}/customers/- to retrieve configs for all customers.

array $optParams

Optional parameters.

Return Value

GoogleCloudChannelV1ListCustomerRepricingConfigsResponse

Exceptions

Exception

GoogleCloudChannelV1CustomerRepricingConfig patch(string $name, GoogleCloudChannelV1CustomerRepricingConfig $postBody, array $optParams = [])

Updates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. This method overwrites the existing CustomerRepricingConfig. You can only update configs if the RepricingConfig.effective_invoice_month is a future month. To make changes to configs for the current month, use CreateCustomerRepricingConfig, taking note of its restrictions. You cannot update the RepricingConfig.effective_invoice_month. When updating a config in the future: This config must already exist. Possible Error Codes: PERMISSION_DENIED: If the account making the request and the account being queried are different. INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated CustomerRepricingConfig resource, otherwise returns an error.

(customerRepricingConfigs.patch)

Parameters

string $name

Output only. Resource name of the CustomerRepricingConfig. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.

GoogleCloudChannelV1CustomerRepricingConfig $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudChannelV1CustomerRepricingConfig

Exceptions

Exception