provider POST /v1/billing/credit_grants
@utdk/stripe /v1/billing/credit_grants
Create a credit grant
<p>Creates a credit grant.</p>

Try it

Authentication
Configure credentials for Stripe API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

postbillingcreditgrants
POST/v1/billing/credit_grants
<p>Creates a credit grant.</p>

Input

required

Amount of this credit grant.

required

Configuration specifying what this credit grant applies to. We currently only support `metered` prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.

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

ID of the customer receiving the billing credits.

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

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

Specifies which fields in the response should be expanded.

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

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.

A descriptive name shown in the Dashboard.

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.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import stripe from '@utdk/stripe';

await stripe.postbillingcreditgrants()