Update credit grant

curl --request PUT \
  --url https://us.api.flexprice.io/v1/creditgrants/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "end_date": "2023-11-07T05:31:56Z",
  "metadata": {},
  "name": "<string>"
}
'

import requests

url = "https://us.api.flexprice.io/v1/creditgrants/{id}"

payload = {
    "end_date": "2023-11-07T05:31:56Z",
    "metadata": {},
    "name": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({end_date: '2023-11-07T05:31:56Z', metadata: {}, name: '<string>'})
};

fetch('https://us.api.flexprice.io/v1/creditgrants/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'end_date' => '2023-11-07T05:31:56Z',
    'metadata' => [
        
    ],
    'name' => '<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/{id}"

	payload := strings.NewReader("{\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"metadata\": {},\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://us.api.flexprice.io/v1/creditgrants/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"metadata\": {},\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.api.flexprice.io/v1/creditgrants/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"metadata\": {},\n  \"name\": \"<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>"
}

PUT

creditgrants

{id}

Update credit grant

curl --request PUT \
  --url https://us.api.flexprice.io/v1/creditgrants/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "end_date": "2023-11-07T05:31:56Z",
  "metadata": {},
  "name": "<string>"
}
'

import requests

url = "https://us.api.flexprice.io/v1/creditgrants/{id}"

payload = {
    "end_date": "2023-11-07T05:31:56Z",
    "metadata": {},
    "name": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({end_date: '2023-11-07T05:31:56Z', metadata: {}, name: '<string>'})
};

fetch('https://us.api.flexprice.io/v1/creditgrants/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'end_date' => '2023-11-07T05:31:56Z',
    'metadata' => [
        
    ],
    'name' => '<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/{id}"

	payload := strings.NewReader("{\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"metadata\": {},\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://us.api.flexprice.io/v1/creditgrants/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"metadata\": {},\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.api.flexprice.io/v1/creditgrants/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"metadata\": {},\n  \"name\": \"<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

x-api-key

string

header

required

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

Path Parameters

string

required

Credit Grant ID

Body

application/json

Credit Grant configuration

end_date

string<date-time>

metadata

object

Show child attributes

name

string

Response

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

string

metadata

object

Show child attributes

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