Sample - Stripe API
POST/v1/billing/credit_grants/{id}/expire

Expire a credit grant

Expires an existing credit grant so its billing credits are no longer available for use after the expiration action. Supply the grant id and optionally use expand to include additional response fields. The response contains the expired credit grant and its current expiration details.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
idstringrequired
The unique identifier of the credit grant to expire.

Optional form-encoded parameters for controlling the response.

expandarray<string>optional
Specifies which fields in the response should be expanded.

2 status codes
200Returns the expired credit grant with its allocation, applicability configuration, expiration time, identifier, metadata, priority, and object status.
amountobjectrequired
applicability_configobjectrequired
categorystringrequired
The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.
Allowed:paidpromotional
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
customerstringrequired
ID of the customer receiving the billing credits.
customer_accountstringoptional
ID of the account representing the customer receiving the billing credits
effective_atintegeroptional
The time when the billing credits become effective-when they're eligible for use.
expires_atintegeroptional
The time when the billing credits expire. If not present, the billing credits don't expire.
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectrequired
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
namestringoptional
A descriptive name shown in dashboard.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:billing.credit_grant
priorityintegeroptional
The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.
test_clockstringoptional
ID of the test clock this credit grant belongs to.
updatedintegerrequired
Time at which the object was last updated. Measured in seconds since the Unix epoch.
voided_atintegeroptional
The time when this credit grant was voided. If not present, the credit grant hasn't been voided.
defaultError response.
errorobjectrequired

Error handling

id must identify the credit grant to expire and must not exceed 5000 characters. Each value in expand must be a string of no more than 5000 characters.