Create credit grant
curl --request POST \
--url https://us.api.flexprice.io/v1/creditgrants \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"credits": "<string>",
"name": "<string>",
"addon_id": "<string>",
"conversion_rate": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"expiration_duration": 123,
"metadata": {},
"period_count": 123,
"plan_id": "<string>",
"priority": 123,
"start_date": "2023-11-07T05:31:56Z",
"subscription_id": "<string>",
"topup_conversion_rate": "<string>"
}
'import requests
url = "https://us.api.flexprice.io/v1/creditgrants"
payload = {
"credits": "<string>",
"name": "<string>",
"addon_id": "<string>",
"conversion_rate": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"expiration_duration": 123,
"metadata": {},
"period_count": 123,
"plan_id": "<string>",
"priority": 123,
"start_date": "2023-11-07T05:31:56Z",
"subscription_id": "<string>",
"topup_conversion_rate": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
credits: '<string>',
name: '<string>',
addon_id: '<string>',
conversion_rate: '<string>',
end_date: '2023-11-07T05:31:56Z',
expiration_duration: 123,
metadata: {},
period_count: 123,
plan_id: '<string>',
priority: 123,
start_date: '2023-11-07T05:31:56Z',
subscription_id: '<string>',
topup_conversion_rate: '<string>'
})
};
fetch('https://us.api.flexprice.io/v1/creditgrants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://us.api.flexprice.io/v1/creditgrants",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'credits' => '<string>',
'name' => '<string>',
'addon_id' => '<string>',
'conversion_rate' => '<string>',
'end_date' => '2023-11-07T05:31:56Z',
'expiration_duration' => 123,
'metadata' => [
],
'period_count' => 123,
'plan_id' => '<string>',
'priority' => 123,
'start_date' => '2023-11-07T05:31:56Z',
'subscription_id' => '<string>',
'topup_conversion_rate' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://us.api.flexprice.io/v1/creditgrants"
payload := strings.NewReader("{\n \"credits\": \"<string>\",\n \"name\": \"<string>\",\n \"addon_id\": \"<string>\",\n \"conversion_rate\": \"<string>\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"expiration_duration\": 123,\n \"metadata\": {},\n \"period_count\": 123,\n \"plan_id\": \"<string>\",\n \"priority\": 123,\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"subscription_id\": \"<string>\",\n \"topup_conversion_rate\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://us.api.flexprice.io/v1/creditgrants")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"credits\": \"<string>\",\n \"name\": \"<string>\",\n \"addon_id\": \"<string>\",\n \"conversion_rate\": \"<string>\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"expiration_duration\": 123,\n \"metadata\": {},\n \"period_count\": 123,\n \"plan_id\": \"<string>\",\n \"priority\": 123,\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"subscription_id\": \"<string>\",\n \"topup_conversion_rate\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.flexprice.io/v1/creditgrants")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"credits\": \"<string>\",\n \"name\": \"<string>\",\n \"addon_id\": \"<string>\",\n \"conversion_rate\": \"<string>\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"expiration_duration\": 123,\n \"metadata\": {},\n \"period_count\": 123,\n \"plan_id\": \"<string>\",\n \"priority\": 123,\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"subscription_id\": \"<string>\",\n \"topup_conversion_rate\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"addon_id": "<string>",
"cadence": "ONETIME",
"conversion_rate": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"credit_grant_anchor": "2023-11-07T05:31:56Z",
"credits": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"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",
"start_date": "2023-11-07T05:31:56Z",
"status": "published",
"subscription_id": "<string>",
"tenant_id": "<string>",
"topup_conversion_rate": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}Credit Grants
Create credit grant
Use when giving a customer or plan credits (e.g. prepaid balance or promotional credits). Scope can be plan or subscription; supports start/end dates.
POST
/
creditgrants
Create credit grant
curl --request POST \
--url https://us.api.flexprice.io/v1/creditgrants \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"credits": "<string>",
"name": "<string>",
"addon_id": "<string>",
"conversion_rate": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"expiration_duration": 123,
"metadata": {},
"period_count": 123,
"plan_id": "<string>",
"priority": 123,
"start_date": "2023-11-07T05:31:56Z",
"subscription_id": "<string>",
"topup_conversion_rate": "<string>"
}
'import requests
url = "https://us.api.flexprice.io/v1/creditgrants"
payload = {
"credits": "<string>",
"name": "<string>",
"addon_id": "<string>",
"conversion_rate": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"expiration_duration": 123,
"metadata": {},
"period_count": 123,
"plan_id": "<string>",
"priority": 123,
"start_date": "2023-11-07T05:31:56Z",
"subscription_id": "<string>",
"topup_conversion_rate": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
credits: '<string>',
name: '<string>',
addon_id: '<string>',
conversion_rate: '<string>',
end_date: '2023-11-07T05:31:56Z',
expiration_duration: 123,
metadata: {},
period_count: 123,
plan_id: '<string>',
priority: 123,
start_date: '2023-11-07T05:31:56Z',
subscription_id: '<string>',
topup_conversion_rate: '<string>'
})
};
fetch('https://us.api.flexprice.io/v1/creditgrants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://us.api.flexprice.io/v1/creditgrants",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'credits' => '<string>',
'name' => '<string>',
'addon_id' => '<string>',
'conversion_rate' => '<string>',
'end_date' => '2023-11-07T05:31:56Z',
'expiration_duration' => 123,
'metadata' => [
],
'period_count' => 123,
'plan_id' => '<string>',
'priority' => 123,
'start_date' => '2023-11-07T05:31:56Z',
'subscription_id' => '<string>',
'topup_conversion_rate' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://us.api.flexprice.io/v1/creditgrants"
payload := strings.NewReader("{\n \"credits\": \"<string>\",\n \"name\": \"<string>\",\n \"addon_id\": \"<string>\",\n \"conversion_rate\": \"<string>\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"expiration_duration\": 123,\n \"metadata\": {},\n \"period_count\": 123,\n \"plan_id\": \"<string>\",\n \"priority\": 123,\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"subscription_id\": \"<string>\",\n \"topup_conversion_rate\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://us.api.flexprice.io/v1/creditgrants")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"credits\": \"<string>\",\n \"name\": \"<string>\",\n \"addon_id\": \"<string>\",\n \"conversion_rate\": \"<string>\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"expiration_duration\": 123,\n \"metadata\": {},\n \"period_count\": 123,\n \"plan_id\": \"<string>\",\n \"priority\": 123,\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"subscription_id\": \"<string>\",\n \"topup_conversion_rate\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.flexprice.io/v1/creditgrants")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"credits\": \"<string>\",\n \"name\": \"<string>\",\n \"addon_id\": \"<string>\",\n \"conversion_rate\": \"<string>\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"expiration_duration\": 123,\n \"metadata\": {},\n \"period_count\": 123,\n \"plan_id\": \"<string>\",\n \"priority\": 123,\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"subscription_id\": \"<string>\",\n \"topup_conversion_rate\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"addon_id": "<string>",
"cadence": "ONETIME",
"conversion_rate": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"credit_grant_anchor": "2023-11-07T05:31:56Z",
"credits": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"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",
"start_date": "2023-11-07T05:31:56Z",
"status": "published",
"subscription_id": "<string>",
"tenant_id": "<string>",
"topup_conversion_rate": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}Authorizations
Enter your API key in the format x-api-key <api-key>*
Body
application/json
Credit Grant configuration
Available options:
ONETIME, RECURRING Available options:
PLAN, SUBSCRIPTION, ADDON 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
Available options:
DAY, WEEK, MONTH, YEAR Available options:
NEVER, DURATION, BILLING_CYCLE Show child attributes
Show child attributes
Available options:
DAILY, WEEKLY, MONTHLY, ANNUAL, QUARTERLY, HALF_YEARLY 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
Response
Created
Available options:
ONETIME, RECURRING 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
Available options:
DAY, WEEK, MONTH, YEAR Available options:
NEVER, DURATION, BILLING_CYCLE Show child attributes
Show child attributes
Available options:
DAILY, WEEKLY, MONTHLY, ANNUAL, QUARTERLY, HALF_YEARLY Available options:
PLAN, SUBSCRIPTION, ADDON Available options:
published, deleted, archived 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