Skip to main content
PUT
Update credit grant

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

id
string
required

Credit Grant ID

Body

application/json

Credit Grant configuration

end_date
string<date-time>
metadata
object
name
string

Response

OK

addon_id
string
cadence
enum<string>
Available options:
ONETIME,
RECURRING
conversion_rate
string

amount in the currency = number of credits * conversion_rate ex if conversion_rate is 1, then 1 USD = 1 credit ex if conversion_rate is 2, then 1 USD = 0.5 credits ex if conversion_rate is 0.5, then 1 USD = 2 credits

created_at
string<date-time>
created_by
string
credit_grant_anchor
string<date-time>
credits
string
end_date
string<date-time>
environment_id
string
expiration_duration
integer
expiration_duration_unit
enum<string>
Available options:
DAY,
WEEK,
MONTH,
YEAR
expiration_type
enum<string>
Available options:
NEVER,
DURATION,
BILLING_CYCLE
id
string
metadata
object
name
string
period
enum<string>
Available options:
DAILY,
WEEKLY,
MONTHLY,
ANNUAL,
QUARTERLY,
HALF_YEARLY
period_count
integer
plan_id
string
priority
integer
scope
enum<string>
Available options:
PLAN,
SUBSCRIPTION,
ADDON
start_date
string<date-time>
status
enum<string>
Available options:
published,
deleted,
archived
subscription_id
string
tenant_id
string
topup_conversion_rate
string

topup_conversion_rate is the conversion rate for the topup to the currency ex if topup_conversion_rate is 1, then 1 USD = 1 credit ex if topup_conversion_rate is 2, then 1 USD = 0.5 credits ex if topup_conversion_rate is 0.5, then 1 USD = 2 credits

updated_at
string<date-time>
updated_by
string