Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Stripe Provider
  4. API Docs
  5. BillingCreditGrant
Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

stripe.BillingCreditGrant

Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

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

    Related guide: Billing credits

    Create BillingCreditGrant Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new BillingCreditGrant(name: string, args: BillingCreditGrantArgs, opts?: CustomResourceOptions);
    @overload
def BillingCreditGrant(resource_name: str,
                       args: BillingCreditGrantArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def BillingCreditGrant(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       amount: Optional[BillingCreditGrantAmountArgs] = None,
                       applicability_config: Optional[BillingCreditGrantApplicabilityConfigArgs] = None,
                       category: Optional[str] = None,
                       customer: Optional[str] = None,
                       customer_account: Optional[str] = None,
                       effective_at: Optional[float] = None,
                       expires_at: Optional[float] = None,
                       metadata: Optional[Mapping[str, str]] = None,
                       name: Optional[str] = None,
                       priority: Optional[float] = None)
    func NewBillingCreditGrant(ctx *Context, name string, args BillingCreditGrantArgs, opts ...ResourceOption) (*BillingCreditGrant, error)
    public BillingCreditGrant(string name, BillingCreditGrantArgs args, CustomResourceOptions? opts = null)
    public BillingCreditGrant(String name, BillingCreditGrantArgs args)
public BillingCreditGrant(String name, BillingCreditGrantArgs args, CustomResourceOptions options)

    type: stripe:BillingCreditGrant
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "stripe_billing_credit_grant" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args BillingCreditGrantArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BillingCreditGrantArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BillingCreditGrantArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BillingCreditGrantArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BillingCreditGrantArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var billingCreditGrantResource = new Stripe.BillingCreditGrant("billingCreditGrantResource", new()
{
    Amount = new Stripe.Inputs.BillingCreditGrantAmountArgs
    {
        Type = "string",
        Monetary = new Stripe.Inputs.BillingCreditGrantAmountMonetaryArgs
        {
            Currency = "string",
            Value = 0.0,
        },
    },
    ApplicabilityConfig = new Stripe.Inputs.BillingCreditGrantApplicabilityConfigArgs
    {
        Scope = new Stripe.Inputs.BillingCreditGrantApplicabilityConfigScopeArgs
        {
            PriceType = "string",
            Prices = new[]
            {
                new Stripe.Inputs.BillingCreditGrantApplicabilityConfigScopePriceArgs
                {
                    Id = "string",
                },
            },
        },
    },
    Category = "string",
    Customer = "string",
    CustomerAccount = "string",
    EffectiveAt = 0.0,
    ExpiresAt = 0.0,
    Metadata = 
    {
        { "string", "string" },
    },
    Name = "string",
    Priority = 0.0,
});

    example, err := stripe.NewBillingCreditGrant(ctx, "billingCreditGrantResource", &stripe.BillingCreditGrantArgs{
	Amount: &stripe.BillingCreditGrantAmountArgs{
		Type: pulumi.String("string"),
		Monetary: &stripe.BillingCreditGrantAmountMonetaryArgs{
			Currency: pulumi.String("string"),
			Value:    pulumi.Float64(0),
		},
	},
	ApplicabilityConfig: &stripe.BillingCreditGrantApplicabilityConfigArgs{
		Scope: &stripe.BillingCreditGrantApplicabilityConfigScopeArgs{
			PriceType: pulumi.String("string"),
			Prices: stripe.BillingCreditGrantApplicabilityConfigScopePriceArray{
				&stripe.BillingCreditGrantApplicabilityConfigScopePriceArgs{
					Id: pulumi.String("string"),
				},
			},
		},
	},
	Category:        pulumi.String("string"),
	Customer:        pulumi.String("string"),
	CustomerAccount: pulumi.String("string"),
	EffectiveAt:     pulumi.Float64(0),
	ExpiresAt:       pulumi.Float64(0),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:     pulumi.String("string"),
	Priority: pulumi.Float64(0),
})

    resource "stripe_billing_credit_grant" "billingCreditGrantResource" {
  lifecycle {
    create_before_destroy = true
  }
  amount = {
    type = "string"
    monetary = {
      currency = "string"
      value    = 0
    }
  }
  applicability_config = {
    scope = {
      price_type = "string"
      prices = [{
        id = "string"
      }]
    }
  }
  category         = "string"
  customer         = "string"
  customer_account = "string"
  effective_at     = 0
  expires_at       = 0
  metadata = {
    "string" = "string"
  }
  name     = "string"
  priority = 0
}

    var billingCreditGrantResource = new BillingCreditGrant("billingCreditGrantResource", BillingCreditGrantArgs.builder()
    .amount(BillingCreditGrantAmountArgs.builder()
        .type("string")
        .monetary(BillingCreditGrantAmountMonetaryArgs.builder()
            .currency("string")
            .value(0.0)
            .build())
        .build())
    .applicabilityConfig(BillingCreditGrantApplicabilityConfigArgs.builder()
        .scope(BillingCreditGrantApplicabilityConfigScopeArgs.builder()
            .priceType("string")
            .prices(BillingCreditGrantApplicabilityConfigScopePriceArgs.builder()
                .id("string")
                .build())
            .build())
        .build())
    .category("string")
    .customer("string")
    .customerAccount("string")
    .effectiveAt(0.0)
    .expiresAt(0.0)
    .metadata(Map.of("string", "string"))
    .name("string")
    .priority(0.0)
    .build());

    billing_credit_grant_resource = stripe.BillingCreditGrant("billingCreditGrantResource",
    amount={
        "type": "string",
        "monetary": {
            "currency": "string",
            "value": float(0),
        },
    },
    applicability_config={
        "scope": {
            "price_type": "string",
            "prices": [{
                "id": "string",
            }],
        },
    },
    category="string",
    customer="string",
    customer_account="string",
    effective_at=float(0),
    expires_at=float(0),
    metadata={
        "string": "string",
    },
    name="string",
    priority=float(0))

    const billingCreditGrantResource = new stripe.BillingCreditGrant("billingCreditGrantResource", {
    amount: {
        type: "string",
        monetary: {
            currency: "string",
            value: 0,
        },
    },
    applicabilityConfig: {
        scope: {
            priceType: "string",
            prices: [{
                id: "string",
            }],
        },
    },
    category: "string",
    customer: "string",
    customerAccount: "string",
    effectiveAt: 0,
    expiresAt: 0,
    metadata: {
        string: "string",
    },
    name: "string",
    priority: 0,
});

    type: stripe:BillingCreditGrant
properties:
    amount:
        monetary:
            currency: string
            value: 0
        type: string
    applicabilityConfig:
        scope:
            priceType: string
            prices:
                - id: string
    category: string
    customer: string
    customerAccount: string
    effectiveAt: 0
    expiresAt: 0
    metadata:
        string: string
    name: string
    priority: 0

    BillingCreditGrant Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The BillingCreditGrant resource accepts the following input properties:

    Amount BillingCreditGrantAmount
    ApplicabilityConfig BillingCreditGrantApplicabilityConfig
    Category string
    The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.
    Customer string
    ID of the customer receiving the billing credits.
    CustomerAccount string
    ID of the account representing the customer receiving the billing credits
    EffectiveAt double
    The time when the billing credits become effective-when they're eligible for use.
    ExpiresAt double
    The time when the billing credits expire. If not present, the billing credits don't expire.
    Metadata Dictionary<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 string
    A descriptive name shown in dashboard.
    Priority double
    The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.
    Amount BillingCreditGrantAmountArgs
    ApplicabilityConfig BillingCreditGrantApplicabilityConfigArgs
    Category string
    The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.
    Customer string
    ID of the customer receiving the billing credits.
    CustomerAccount string
    ID of the account representing the customer receiving the billing credits
    EffectiveAt float64
    The time when the billing credits become effective-when they're eligible for use.
    ExpiresAt float64
    The time when the billing credits expire. If not present, the billing credits don't expire.
    Metadata map[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 string
    A descriptive name shown in dashboard.
    Priority float64
    The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.
    amount object
    applicability_config object
    category string
    The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.
    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.
    expires_at number
    The time when the billing credits expire. If not present, the billing credits don't expire.
    metadata map(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 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.
    amount BillingCreditGrantAmount
    applicabilityConfig BillingCreditGrantApplicabilityConfig
    category String
    The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.
    customer String
    ID of the customer receiving the billing credits.
    customerAccount String
    ID of the account representing the customer receiving the billing credits
    effectiveAt Double
    The time when the billing credits become effective-when they're eligible for use.
    expiresAt Double
    The time when the billing credits expire. If not present, the billing credits don't expire.
    metadata Map<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 String
    A descriptive name shown in dashboard.
    priority Double
    The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.
    amount BillingCreditGrantAmount
    applicabilityConfig BillingCreditGrantApplicabilityConfig
    category string
    The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.
    customer string
    ID of the customer receiving the billing credits.
    customerAccount string
    ID of the account representing the customer receiving the billing credits
    effectiveAt number
    The time when the billing credits become effective-when they're eligible for use.
    expiresAt number
    The time when the billing credits expire. If not present, the billing credits don't expire.
    metadata {[key: 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 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.
    amount BillingCreditGrantAmountArgs
    applicability_config BillingCreditGrantApplicabilityConfigArgs
    category str
    The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.
    customer str
    ID of the customer receiving the billing credits.
    customer_account str
    ID of the account representing the customer receiving the billing credits
    effective_at float
    The time when the billing credits become effective-when they're eligible for use.
    expires_at float
    The time when the billing credits expire. If not present, the billing credits don't expire.
    metadata Mapping[str, str]
    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 str
    A descriptive name shown in dashboard.
    priority float
    The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.
    amount Property Map
    applicabilityConfig Property Map
    category String
    The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.
    customer String
    ID of the customer receiving the billing credits.
    customerAccount String
    ID of the account representing the customer receiving the billing credits
    effectiveAt Number
    The time when the billing credits become effective-when they're eligible for use.
    expiresAt Number
    The time when the billing credits expire. If not present, the billing credits don't expire.
    metadata Map<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 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BillingCreditGrant resource produces the following output properties:

    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Id string
    The provider-assigned unique ID for this managed resource.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    TestClock string
    ID of the test clock this credit grant belongs to.
    Updated double
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    VoidedAt double
    The time when this credit grant was voided. If not present, the credit grant hasn't been voided.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Id string
    The provider-assigned unique ID for this managed resource.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    TestClock string
    ID of the test clock this credit grant belongs to.
    Updated float64
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    VoidedAt float64
    The time when this credit grant was voided. If not present, the credit grant hasn't been voided.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id string
    The provider-assigned unique ID for this managed resource.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object string
    String representing the object's type. Objects of the same type share the same value.
    test_clock string
    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.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id String
    The provider-assigned unique ID for this managed resource.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object String
    String representing the object's type. Objects of the same type share the same value.
    testClock String
    ID of the test clock this credit grant belongs to.
    updated Double
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    voidedAt Double
    The time when this credit grant was voided. If not present, the credit grant hasn't been voided.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id string
    The provider-assigned unique ID for this managed resource.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object string
    String representing the object's type. Objects of the same type share the same value.
    testClock string
    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.
    voidedAt number
    The time when this credit grant was voided. If not present, the credit grant hasn't been voided.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id str
    The provider-assigned unique ID for this managed resource.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object str
    String representing the object's type. Objects of the same type share the same value.
    test_clock str
    ID of the test clock this credit grant belongs to.
    updated float
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    voided_at float
    The time when this credit grant was voided. If not present, the credit grant hasn't been voided.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id String
    The provider-assigned unique ID for this managed resource.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object String
    String representing the object's type. Objects of the same type share the same value.
    testClock String
    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.
    voidedAt Number
    The time when this credit grant was voided. If not present, the credit grant hasn't been voided.

    Look up Existing BillingCreditGrant Resource

    Get an existing BillingCreditGrant resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BillingCreditGrantState, opts?: CustomResourceOptions): BillingCreditGrant
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        amount: Optional[BillingCreditGrantAmountArgs] = None,
        applicability_config: Optional[BillingCreditGrantApplicabilityConfigArgs] = None,
        category: Optional[str] = None,
        created: Optional[float] = None,
        customer: Optional[str] = None,
        customer_account: Optional[str] = None,
        effective_at: Optional[float] = None,
        expires_at: Optional[float] = None,
        livemode: Optional[bool] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        object: Optional[str] = None,
        priority: Optional[float] = None,
        test_clock: Optional[str] = None,
        updated: Optional[float] = None,
        voided_at: Optional[float] = None) -> BillingCreditGrant
    func GetBillingCreditGrant(ctx *Context, name string, id IDInput, state *BillingCreditGrantState, opts ...ResourceOption) (*BillingCreditGrant, error)
    public static BillingCreditGrant Get(string name, Input<string> id, BillingCreditGrantState? state, CustomResourceOptions? opts = null)
    public static BillingCreditGrant get(String name, Output<String> id, BillingCreditGrantState state, CustomResourceOptions options)
    resources:  _:    type: stripe:BillingCreditGrant    get:      id: ${id}
    import {
  to = stripe_billing_credit_grant.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Amount BillingCreditGrantAmount
    ApplicabilityConfig BillingCreditGrantApplicabilityConfig
    Category string
    The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Customer string
    ID of the customer receiving the billing credits.
    CustomerAccount string
    ID of the account representing the customer receiving the billing credits
    EffectiveAt double
    The time when the billing credits become effective-when they're eligible for use.
    ExpiresAt double
    The time when the billing credits expire. If not present, the billing credits don't expire.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Metadata Dictionary<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 string
    A descriptive name shown in dashboard.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Priority double
    The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.
    TestClock string
    ID of the test clock this credit grant belongs to.
    Updated double
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    VoidedAt double
    The time when this credit grant was voided. If not present, the credit grant hasn't been voided.
    Amount BillingCreditGrantAmountArgs
    ApplicabilityConfig BillingCreditGrantApplicabilityConfigArgs
    Category string
    The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Customer string
    ID of the customer receiving the billing credits.
    CustomerAccount string
    ID of the account representing the customer receiving the billing credits
    EffectiveAt float64
    The time when the billing credits become effective-when they're eligible for use.
    ExpiresAt float64
    The time when the billing credits expire. If not present, the billing credits don't expire.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Metadata map[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 string
    A descriptive name shown in dashboard.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Priority float64
    The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.
    TestClock string
    ID of the test clock this credit grant belongs to.
    Updated float64
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    VoidedAt float64
    The time when this credit grant was voided. If not present, the credit grant hasn't been voided.
    amount object
    applicability_config object
    category string
    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
    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 bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata map(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 string
    A descriptive name shown in dashboard.
    object string
    String representing the object's type. Objects of the same type share the same value.
    priority number
    The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.
    test_clock string
    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.
    amount BillingCreditGrantAmount
    applicabilityConfig BillingCreditGrantApplicabilityConfig
    category String
    The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    customer String
    ID of the customer receiving the billing credits.
    customerAccount String
    ID of the account representing the customer receiving the billing credits
    effectiveAt Double
    The time when the billing credits become effective-when they're eligible for use.
    expiresAt Double
    The time when the billing credits expire. If not present, the billing credits don't expire.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata Map<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 String
    A descriptive name shown in dashboard.
    object String
    String representing the object's type. Objects of the same type share the same value.
    priority Double
    The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.
    testClock String
    ID of the test clock this credit grant belongs to.
    updated Double
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    voidedAt Double
    The time when this credit grant was voided. If not present, the credit grant hasn't been voided.
    amount BillingCreditGrantAmount
    applicabilityConfig BillingCreditGrantApplicabilityConfig
    category string
    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
    ID of the customer receiving the billing credits.
    customerAccount string
    ID of the account representing the customer receiving the billing credits
    effectiveAt number
    The time when the billing credits become effective-when they're eligible for use.
    expiresAt number
    The time when the billing credits expire. If not present, the billing credits don't expire.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata {[key: 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 string
    A descriptive name shown in dashboard.
    object string
    String representing the object's type. Objects of the same type share the same value.
    priority number
    The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.
    testClock string
    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.
    voidedAt number
    The time when this credit grant was voided. If not present, the credit grant hasn't been voided.
    amount BillingCreditGrantAmountArgs
    applicability_config BillingCreditGrantApplicabilityConfigArgs
    category str
    The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    customer str
    ID of the customer receiving the billing credits.
    customer_account str
    ID of the account representing the customer receiving the billing credits
    effective_at float
    The time when the billing credits become effective-when they're eligible for use.
    expires_at float
    The time when the billing credits expire. If not present, the billing credits don't expire.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata Mapping[str, str]
    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 str
    A descriptive name shown in dashboard.
    object str
    String representing the object's type. Objects of the same type share the same value.
    priority float
    The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.
    test_clock str
    ID of the test clock this credit grant belongs to.
    updated float
    Time at which the object was last updated. Measured in seconds since the Unix epoch.
    voided_at float
    The time when this credit grant was voided. If not present, the credit grant hasn't been voided.
    amount Property Map
    applicabilityConfig Property Map
    category String
    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
    ID of the customer receiving the billing credits.
    customerAccount String
    ID of the account representing the customer receiving the billing credits
    effectiveAt Number
    The time when the billing credits become effective-when they're eligible for use.
    expiresAt Number
    The time when the billing credits expire. If not present, the billing credits don't expire.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata Map<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 String
    A descriptive name shown in dashboard.
    object String
    String representing the object's type. Objects of the same type share the same value.
    priority Number
    The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.
    testClock String
    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.
    voidedAt Number
    The time when this credit grant was voided. If not present, the credit grant hasn't been voided.

    Supporting Types

    BillingCreditGrantAmount, BillingCreditGrantAmountArgs

    Type string
    The type of this amount. We currently only support monetary billing credits.
    Monetary BillingCreditGrantAmountMonetary
    The monetary amount.
    Type string
    The type of this amount. We currently only support monetary billing credits.
    Monetary BillingCreditGrantAmountMonetary
    The monetary amount.
    type string
    The type of this amount. We currently only support monetary billing credits.
    monetary object
    The monetary amount.
    type String
    The type of this amount. We currently only support monetary billing credits.
    monetary BillingCreditGrantAmountMonetary
    The monetary amount.
    type string
    The type of this amount. We currently only support monetary billing credits.
    monetary BillingCreditGrantAmountMonetary
    The monetary amount.
    type str
    The type of this amount. We currently only support monetary billing credits.
    monetary BillingCreditGrantAmountMonetary
    The monetary amount.
    type String
    The type of this amount. We currently only support monetary billing credits.
    monetary Property Map
    The monetary amount.

    BillingCreditGrantAmountMonetary, BillingCreditGrantAmountMonetaryArgs

    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Value double
    A positive integer representing the amount.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Value float64
    A positive integer representing the amount.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    value number
    A positive integer representing the amount.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    value Double
    A positive integer representing the amount.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    value number
    A positive integer representing the amount.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    value float
    A positive integer representing the amount.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    value Number
    A positive integer representing the amount.

    BillingCreditGrantApplicabilityConfig, BillingCreditGrantApplicabilityConfigArgs

    BillingCreditGrantApplicabilityConfigScope, BillingCreditGrantApplicabilityConfigScopeArgs

    PriceType string
    The price type that credit grants can apply to. We currently only support the metered price type. This refers to prices that have a Billing Meter attached to them. Cannot be used in combination with prices.
    Prices List<BillingCreditGrantApplicabilityConfigScopePrice>
    The prices that credit grants can apply to. We currently only support metered prices. This refers to prices that have a Billing Meter attached to them. Cannot be used in combination with price_type.
    PriceType string
    The price type that credit grants can apply to. We currently only support the metered price type. This refers to prices that have a Billing Meter attached to them. Cannot be used in combination with prices.
    Prices []BillingCreditGrantApplicabilityConfigScopePrice
    The prices that credit grants can apply to. We currently only support metered prices. This refers to prices that have a Billing Meter attached to them. Cannot be used in combination with price_type.
    price_type string
    The price type that credit grants can apply to. We currently only support the metered price type. This refers to prices that have a Billing Meter attached to them. Cannot be used in combination with prices.
    prices list(object)
    The prices that credit grants can apply to. We currently only support metered prices. This refers to prices that have a Billing Meter attached to them. Cannot be used in combination with price_type.
    priceType String
    The price type that credit grants can apply to. We currently only support the metered price type. This refers to prices that have a Billing Meter attached to them. Cannot be used in combination with prices.
    prices List<BillingCreditGrantApplicabilityConfigScopePrice>
    The prices that credit grants can apply to. We currently only support metered prices. This refers to prices that have a Billing Meter attached to them. Cannot be used in combination with price_type.
    priceType string
    The price type that credit grants can apply to. We currently only support the metered price type. This refers to prices that have a Billing Meter attached to them. Cannot be used in combination with prices.
    prices BillingCreditGrantApplicabilityConfigScopePrice[]
    The prices that credit grants can apply to. We currently only support metered prices. This refers to prices that have a Billing Meter attached to them. Cannot be used in combination with price_type.
    price_type str
    The price type that credit grants can apply to. We currently only support the metered price type. This refers to prices that have a Billing Meter attached to them. Cannot be used in combination with prices.
    prices Sequence[BillingCreditGrantApplicabilityConfigScopePrice]
    The prices that credit grants can apply to. We currently only support metered prices. This refers to prices that have a Billing Meter attached to them. Cannot be used in combination with price_type.
    priceType String
    The price type that credit grants can apply to. We currently only support the metered price type. This refers to prices that have a Billing Meter attached to them. Cannot be used in combination with prices.
    prices List<Property Map>
    The prices that credit grants can apply to. We currently only support metered prices. This refers to prices that have a Billing Meter attached to them. Cannot be used in combination with price_type.

    BillingCreditGrantApplicabilityConfigScopePrice, BillingCreditGrantApplicabilityConfigScopePriceArgs

    Id string
    Unique identifier for the object.
    Id string
    Unique identifier for the object.
    id string
    Unique identifier for the object.
    id String
    Unique identifier for the object.
    id string
    Unique identifier for the object.
    id str
    Unique identifier for the object.
    id String
    Unique identifier for the object.

    Package Details

    Repository
    stripe stripe/terraform-provider-stripe
    License
    Notes
    This Pulumi package is based on the stripe Terraform Provider.
    Viewing docs for Stripe 0.3.0
    published on Friday, Aug 14, 2026 by Pulumi
    Schema (JSON)
    stripe/terraform-provider-stripe

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial