Void

API Reference

V1

Credit Grants

Void a credit grant

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

post/v1/credits/voidGrant

Void a credit grant

Parameters

idString

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

dataidStringID

HTTPTypeScriptPythonGoRubyTerraform

require "metronome_sdk"

metronome = MetronomeSDK::Client.new(bearer_token: "My Bearer Token")

response = metronome.v1.credit_grants.void(id: "9b85c1c1-5238-4f2a-a409-61412905e1e1")

puts(response)

200 Example

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