Edit

API Reference

V1

Credit Grants

Update a credit grant

v1.credit_grants.edit(CreditGrantEditParams**kwargs) -> dataIDCreditGrantEditResponse

post/v1/credits/editGrant

Edit an existing credit grant

Parameters

idstr

the ID of the credit grant

formatuuid

credit_grant_typestr

optional

the updated credit grant type

expires_atunion

optional

Union[str, datetime]

the updated expiration date for the credit grant

formatdate-time

namestr

optional

the updated name for the credit grant

Returns

CreditGrantEditResponseclass

Hide ParametersShow Parameters

dataidstrID

HTTPTypeScriptPythonGoRubyTerraform

from datetime import datetime
from metronome import Metronome

client = Metronome(
    bearer_token="My Bearer Token",
)
response = client.v1.credit_grants.edit(
    id="9b85c1c1-5238-4f2a-a409-61412905e1e1",
    expires_at=datetime.fromisoformat("2022-04-01T00:00:00"),
    name="Acme Corp Promotional Credit Grant",
)
print(response.data)

200 Example

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