Struct BillingCreditGrant

pub struct BillingCreditGrant {

    pub amount: BillingCreditGrantsResourceAmount,
    pub applicability_config: BillingCreditGrantsResourceApplicabilityConfig,
    pub category: BillingCreditGrantCategory,
    pub created: Timestamp,
    pub customer: Expandable<Customer>,
    pub effective_at: Option<Timestamp>,
    pub expires_at: Option<Timestamp>,
    pub id: BillingCreditGrantId,
    pub livemode: bool,
    pub metadata: HashMap<String, String>,
    pub name: Option<String>,
    pub priority: Option<i64>,
    pub test_clock: Option<Expandable<TestHelpersTestClock>>,
    pub updated: Timestamp,
    pub voided_at: Option<Timestamp>,
}

A credit grant is an API resource that documents the allocation of some billing credits to a customer.

Related guide: Billing credits.

Fields

amount: BillingCreditGrantsResourceAmount

applicability_config: BillingCreditGrantsResourceApplicabilityConfig

category: BillingCreditGrantCategory

The category of this credit grant. This is for tracking purposes and isn’t displayed to the customer.

created: Timestamp

Time at which the object was created. Measured in seconds since the Unix epoch.

customer: Expandable<Customer>

ID of the customer receiving the billing credits.

effective_at: Option<Timestamp>

The time when the billing credits become effective-when they’re eligible for use.

expires_at: Option<Timestamp>

The time when the billing credits expire. If not present, the billing credits don’t expire.

id: BillingCreditGrantId

Unique identifier for the object.

livemode: bool

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata: HashMap<String, String>

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

name: Option<String>

A descriptive name shown in dashboard.

priority: Option<i64>

The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.

test_clock: Option<Expandable<TestHelpersTestClock>>

ID of the test clock this credit grant belongs to.

updated: Timestamp

Time at which the object was last updated. Measured in seconds since the Unix epoch.

voided_at: Option<Timestamp>

The time when this credit grant was voided. If not present, the credit grant hasn’t been voided.

Trait Implementations

impl Clone for BillingCreditGrant

fn clone(&self) -> BillingCreditGrant

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BillingCreditGrant

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deserialize for BillingCreditGrant

fn begin(out: &mut Option<Self>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl FromValueOpt for BillingCreditGrant

fn from_value(v: Value) -> Option<Self>

impl Object for BillingCreditGrant

type Id = BillingCreditGrantId

The canonical id type for this object.

fn id(&self) -> &Self::Id

The id of the object.

fn into_id(self) -> Self::Id

The owned id of the object.

impl ObjectDeser for BillingCreditGrant

type Builder = BillingCreditGrantBuilder