Mayson Monorepo Documentation
    Preparing search index...

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

    Related guide: Billing credits

    interface CreditGrant {
        id: string;
        object: "billing.credit_grant";
        amount: Stripe.Billing.CreditGrant.Amount;
        applicability_config: Stripe.Billing.CreditGrant.ApplicabilityConfig;
        category: Stripe.Billing.CreditGrant.Category;
        created: number;
        customer: string | Stripe.Customer | DeletedCustomer;
        customer_account: string;
        effective_at: number;
        expires_at: number;
        livemode: boolean;
        metadata: Metadata;
        name: string;
        priority?: number;
        test_clock: string | Stripe.TestHelpers.TestClock;
        updated: number;
        voided_at: number;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "billing.credit_grant"

    String representing the object's type. Objects of the same type share the same value.

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

    created: number

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

    customer: string | Stripe.Customer | DeletedCustomer

    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.

    expires_at: number

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

    livemode: boolean

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

    metadata: Metadata

    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: string

    A descriptive name shown in dashboard.

    priority?: number

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

    test_clock: string | Stripe.TestHelpers.TestClock

    ID of the test clock this credit grant belongs to.

    updated: number

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

    voided_at: number

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