Skip to main content
POST
/
credits
/
voidGrant
Void a credit grant
curl --request POST \
  --url https://api.metronome.com/v1/credits/voidGrant \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "void_credit_purchase_invoice": true,
  "release_uniqueness_key": true
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The ID of the grant to void

​
id
string<uuid>
required
​
void_credit_purchase_invoice
boolean

If true, void the purchase invoice associated with the grant

​
release_uniqueness_key
boolean

If true, resets the uniqueness key on this grant so it can be re-used

Response

Success

​
data
object
required