Credit Grants

Get credit grant

Changed on

Use when you need to load a single credit grant (e.g. for display or to check balance).

get/creditgrants/{id}

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/creditgrants/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Credit Grant ID

Response

OK

addon_idstring
cadence'ONETIME' | 'RECURRING'
conversion_ratestring

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_atstring date-time
created_bystring
credit_grant_anchorstring date-time
creditsstring
end_datestring date-time
environment_idstring
expiration_durationinteger
expiration_duration_unit'DAY' | 'WEEK' | 'MONTH' | 'YEAR'
expiration_type'NEVER' | 'DURATION' | 'BILLING_CYCLE'
idstring
metadataTypesMetadata
namestring
period'DAILY' | 'WEEKLY' | 'MONTHLY' | 'ANNUAL' | 'QUARTERLY' | 'HALF_YEARLY'
period_countinteger
plan_idstring
priorityinteger
scope'PLAN' | 'SUBSCRIPTION' | 'ADDON'
start_datestring date-time
status'published' | 'deleted' | 'archived'
subscription_idstring
tenant_idstring
topup_conversion_ratestring

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_atstring date-time
updated_bystring

Changes

  • f8ecf435d25dRevision changes
    • warning

      added the new ADDON enum value to the response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status

    • info

      added the optional property to the response with the status

  • 7d57386313c7Revision changes
    • breaking

      the response's property type changed from no type to object for status

    • breaking

      the response's property type changed from no type to string for status

    • warning

      added the new archived enum value to the response property for the response status

    • warning

      added the new deleted enum value to the response property for the response status

    • warning

      added the new published enum value to the response property for the response status