Void

API Reference

V1

Credit Grants

Void a credit grant

v1.credit_grants.void(CreditGrantVoidParams**kwargs) -> dataIDCreditGrantVoidResponse

post/v1/credits/voidGrant

Void a credit grant

Parameters

idstr

formatuuid

release_uniqueness_keybool

optional

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

void_credit_purchase_invoicebool

optional

If true, void the purchase invoice associated with the grant

Returns

CreditGrantVoidResponseclass

Hide ParametersShow Parameters

dataidstrID

HTTPTypeScriptPythonGoRubyTerraform

from metronome import Metronome

client = Metronome(
    bearer_token="My Bearer Token",
)
response = client.v1.credit_grants.void(
    id="9b85c1c1-5238-4f2a-a409-61412905e1e1",
)
print(response.data)

200 Example

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