Void a credit grant

Billing

Credit Grant

Void a credit grant

Voids a credit grant.

Parameters

idstringRequired
Unique identifier for the object.

Returns

Returns the voided credit grant.

POST /v1/billing/credit_grants/:id/void

Server-side language

curl -X POST https://api.stripe.com/v1/billing/credit_grants/credgr_test_61R9rnNTDmZ657a2r41L6nFOS1ekD5Ae/void \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"

Response

{
  "id": "credgr_test_61R9rnNTDmZ657a2r41L6nFOS1ekD5Ae",
  "object": "billing.credit_grant",
  "amount": {
    "monetary": {
      "currency": "usd",
      "value": 1000
    },
    "type": "monetary"
  },
  "applicability_config": {
    "scope": {
      "price_type": "metered"
    }
  },
  "category": "paid",
  "created": 1726688817,
  "customer": "cus_QsEHa3GKweMwih",
  "effective_at": 1726688817,
  "expires_at": null,
  "livemode": false,
  "metadata": {},
  "name": "Purchased Credits",
  "priority": 50,
  "test_clock": null,
  "updated": 1726688829,
  "voided_at": 1726688829
}

Void a credit grant

Parameters

idstringRequired

Returns