Void

API Reference

V1

Credit Grants

Void a credit grant

client.V1.CreditGrants.Void(ctx, body) (*DataIDV1CreditGrantVoidResponse, error)

post/v1/credits/voidGrant

Void a credit grant

Parameters

bodyIDfieldReleaseUniquenessKeyfieldVoidCreditPurchaseInvoicefieldV1CreditGrantVoidParams

Hide ParametersShow Parameters

IDfield

param.Field[string]

formatuuid

ReleaseUniquenessKeyfield

optional

param.Field[bool]

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

VoidCreditPurchaseInvoicefield

optional

param.Field[bool]

If true, void the purchase invoice associated with the grant

Returns

V1CreditGrantVoidResponsestruct

Hide ParametersShow Parameters

DataIDstringID

HTTPTypeScriptPythonGoRubyTerraform

package main

import (
  "context"
  "fmt"

  "github.com/Metronome-Industries/metronome-go"
  "github.com/Metronome-Industries/metronome-go/option"
)

func main() {
  client := metronome.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.V1.CreditGrants.Void(context.TODO(), metronome.V1CreditGrantVoidParams{
    ID: metronome.F("9b85c1c1-5238-4f2a-a409-61412905e1e1"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Data)
}

200 Example

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