Skip to main content
POST
/
creditgrants
Create a new credit grant
curl --request POST \
  --url https://api.cloud.flexprice.io/v1/creditgrants \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "cadence": "ONETIME",
  "credits": 123,
  "expiration_duration": 123,
  "expiration_duration_unit": "DAY",
  "expiration_type": "NEVER",
  "metadata": {},
  "name": "<string>",
  "period": "DAILY",
  "period_count": 123,
  "plan_id": "<string>",
  "priority": 123,
  "scope": "PLAN",
  "subscription_id": "<string>"
}'
{
  "cadence": "ONETIME",
  "created_at": "<string>",
  "created_by": "<string>",
  "credits": 123,
  "environment_id": "<string>",
  "expiration_duration": 123,
  "expiration_duration_unit": "DAY",
  "expiration_type": "NEVER",
  "id": "<string>",
  "metadata": {},
  "name": "<string>",
  "period": "DAILY",
  "period_count": 123,
  "plan_id": "<string>",
  "priority": 123,
  "scope": "PLAN",
  "status": "published",
  "subscription_id": "<string>",
  "tenant_id": "<string>",
  "updated_at": "<string>",
  "updated_by": "<string>"
}

Authorizations

x-api-key
string
header
required

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

Body

application/json

Credit Grant configuration

cadence
enum<string>
required
Available options:
ONETIME,
RECURRING
credits
number
required
name
string
required
scope
enum<string>
required
Available options:
PLAN,
SUBSCRIPTION
expiration_duration
integer
expiration_duration_unit
enum<string>
Available options:
DAY,
WEEK,
MONTH,
YEAR
expiration_type
enum<string>
Available options:
NEVER,
DURATION,
BILLING_CYCLE
metadata
object
period
enum<string>
Available options:
DAILY,
WEEKLY,
MONTHLY,
ANNUAL,
QUARTERLY,
HALF_YEARLY
period_count
integer
plan_id
string
priority
integer
subscription_id
string

Response

Created

cadence
enum<string>
Available options:
ONETIME,
RECURRING
created_at
string
created_by
string
credits
number
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
status
enum<string>
Available options:
published,
deleted,
archived
subscription_id
string
tenant_id
string
updated_at
string
updated_by
string
I