AppliedIncentive

Represents an applied incentive.

Proto definition

Fields

coupon_code

string

Output only. The coupon code of the incentive.

currency_code

string

Output only. The currency code for all monetary amounts (for example, "USD").

current_spend_towards_fulfillment_micros

int64

Output only. The current amount spent towards the fulfillment requirements, in micros.

fulfillment_expiration_date_time

string

Output only. The time by which the incentive's fulfillment requirements must be met, in "YYYY-MM-DD HH:MM:SS" format in UTC.

granted_amount_micros

int64

Output only. The amount of the reward granted in micros. This field is not set if the reward has not been granted.

incentive_state

IncentiveState

Output only. The current state of the incentive.

redemption_date_time

string

Output only. The redemption time of the incentive in "YYYY-MM-DD HH:MM:SS" format in UTC.

required_min_spend_micros

int64

Output only. The minimum amount that must be spent to fulfill the coupon requirements, in micros.

resource_name

string

Output only. The resource name of the incentive. Incentive resource names have the form:

customers/{customer_id}/appliedIncentives/{coupon_code}

reward_amount_micros

int64

Output only. The maximum potential reward amount in micros for the incentive.

reward_balance_remaining_micros

int64

Output only. The remaining balance of the granted reward in micros. This field is not set if the reward has not been granted.

reward_expiration_date_time

string

Output only. The time when the granted reward expires in "YYYY-MM-DD HH:MM:SS" format in UTC. This field is not set if the reward has not been granted.

reward_grant_date_time

string

Output only. The time when the reward was granted in "YYYY-MM-DD HH:MM:SS" format in UTC. This field is not set if the reward has not been granted.