# Google Cloud Channel V1 Client - Class Plan (2.4.1)

2.4.1 (latest) 2.4.0 2.3.1 2.2.1 2.1.4 2.0.0 1.9.5 1.8.2 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.1 1.1.1 1.0.1 Reference documentation and code samples for the Google Cloud Channel V1 Client class Plan.

The payment plan for the Offer. Describes how to make a payment.

Generated from protobuf message `google.cloud.channel.v1.Plan`

## Namespace

Google \\ Cloud \\ Channel \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ payment_plan` | `int` Describes how a reseller will be billed. |
| `↳ payment_type` | `int` Specifies when the payment needs to happen. |
| `↳ payment_cycle` | `https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.Period` Describes how frequently the reseller will be billed, such as once per month. |
| `↳ trial_period` | `https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.Period` Present for Offers with a trial period. For trial-only Offers, a paid service needs to start before the trial period ends for continued service. For Regular Offers with a trial period, the regular pricing goes into effect when trial period ends, or if paid service is started before the end of the trial period. |
| `↳ billing_account` | `string` Reseller Billing account to charge after an offer transaction. Only present for Google Cloud offers. |

### getPaymentPlan

Describes how a reseller will be billed.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [PaymentPlan](https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.PaymentPlan). |

### setPaymentPlan

Describes how a reseller will be billed.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [PaymentPlan](https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.PaymentPlan). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPaymentType

Specifies when the payment needs to happen.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [PaymentType](https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.PaymentType). |

### setPaymentType

Specifies when the payment needs to happen.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [PaymentType](https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.PaymentType). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPaymentCycle

Describes how frequently the reseller will be billed, such as
once per month.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.Period|null` |   |

### hasPaymentCycle

### clearPaymentCycle

### setPaymentCycle

Describes how frequently the reseller will be billed, such as
once per month.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.Period` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getTrialPeriod

Present for Offers with a trial period.

For trial-only Offers, a paid service needs to start before the trial
period ends for continued service.
For Regular Offers with a trial period, the regular pricing goes into
effect when trial period ends, or if paid service is started before the end
of the trial period.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.Period|null` |   |

### hasTrialPeriod

### clearTrialPeriod

### setTrialPeriod

Present for Offers with a trial period.

For trial-only Offers, a paid service needs to start before the trial
period ends for continued service.
For Regular Offers with a trial period, the regular pricing goes into
effect when trial period ends, or if paid service is started before the end
of the trial period.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.Period` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getBillingAccount

Reseller Billing account to charge after an offer transaction.

Only present for Google Cloud offers.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setBillingAccount

Reseller Billing account to charge after an offer transaction.

Only present for Google Cloud offers.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |