Mayson Monorepo Documentation
    Preparing search index...

    Interface CreditGrantCreateParams

    interface CreditGrantCreateParams {
        amount: Stripe.Billing.CreditGrantCreateParams.Amount;
        applicability_config: Stripe.Billing.CreditGrantCreateParams.ApplicabilityConfig;
        category?: Stripe.Billing.CreditGrantCreateParams.Category;
        customer?: string;
        customer_account?: string;
        effective_at?: number;
        expand?: string[];
        expires_at?: number;
        metadata?: MetadataParam;
        name?: string;
        priority?: number;
    }
    Index

    Properties

    amount applicability_config category? customer? customer_account? effective_at? expand? expires_at? metadata? name? priority?

    Properties

    amount: Stripe.Billing.CreditGrantCreateParams.Amount

    Amount of this credit grant.

    applicability_config: Stripe.Billing.CreditGrantCreateParams.ApplicabilityConfig

    Configuration specifying what this credit grant applies to. We currently only support metered prices that have a Billing Meter attached to them.

    category?: Stripe.Billing.CreditGrantCreateParams.Category

    The category of this credit grant. It defaults to paid if not specified.

    customer?: string

    ID of the customer receiving the billing credits.

    customer_account?: string

    ID of the account representing the customer receiving the billing credits.

    effective_at?: number

    The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    expires_at?: number

    The time when the billing credits expire. If not specified, the billing credits don't expire.

    metadata?: MetadataParam

    Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.

    name?: string

    A descriptive name shown in the Dashboard.

    priority?: number

    The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100.

    Settings

    Member Visibility

    On This Page

    Properties