Void

API Reference

V1

Credit Grants

Void a credit grant

client.v1.creditGrants.void(CreditGrantVoidParamsbody, RequestOptionsoptions?): dataIDCreditGrantVoidResponse

post/v1/credits/voidGrant

Void a credit grant

Parameters

bodyidstringrelease_uniqueness_keybooleanvoid_credit_purchase_invoicebooleanCreditGrantVoidParams

Hide ParametersShow Parameters

idstring

formatuuid

release_uniqueness_keyboolean

optional

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

void_credit_purchase_invoiceboolean

optional

If true, void the purchase invoice associated with the grant

Returns

CreditGrantVoidResponse

Hide ParametersShow Parameters

dataidstringID

HTTPTypeScriptPythonGoRubyTerraform

import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

const response = await client.v1.creditGrants.void({ id: '9b85c1c1-5238-4f2a-a409-61412905e1e1' });

console.log(response.data);

200 Example

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}