GET
/
creditgrants
curl --request GET \
  --url https://api.cloud.flexprice.io/v1/creditgrants \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "cadence": "ONETIME",
      "created_at": "<string>",
      "created_by": "<string>",
      "credits": 123,
      "currency": "<string>",
      "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>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

​
x-api-key
string
header
required

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

Query Parameters

​
end_time
string
​
expand
string
​
limit
integer
Required range: 1 <= x <= 1000
​
offset
integer
Required range: x >= 0
​
order
enum<string>
Available options:
asc,
desc
​
plan_ids
string[]

Specific filters for credit grants

​
sort
string
​
start_time
string
​
status
enum<string>
Available options:
published,
deleted,
archived
​
subscription_ids
string[]

Response

200
application/json

OK

The response is of type object.