Credits
Update Credit
Update a credit’s name, expiration date, or product restrictions
PATCH
/
companies
/
{company_id}
/
credits
/
{id}
Update Credit
curl --request PATCH \
--url https://api.getmeasure.com/api/v1/companies/{company_id}/credits/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expiration_date": "2023-11-07T05:31:56Z",
"name": "<string>",
"product_ids": [
"<string>"
]
}
'import requests
url = "https://api.getmeasure.com/api/v1/companies/{company_id}/credits/{id}"
payload = {
"expiration_date": "2023-11-07T05:31:56Z",
"name": "<string>",
"product_ids": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expiration_date: '2023-11-07T05:31:56Z',
name: '<string>',
product_ids: ['<string>']
})
};
fetch('https://api.getmeasure.com/api/v1/companies/{company_id}/credits/{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://api.getmeasure.com/api/v1/companies/{company_id}/credits/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'expiration_date' => '2023-11-07T05:31:56Z',
'name' => '<string>',
'product_ids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.getmeasure.com/api/v1/companies/{company_id}/credits/{id}"
payload := strings.NewReader("{\n \"expiration_date\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"product_ids\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.getmeasure.com/api/v1/companies/{company_id}/credits/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expiration_date\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"product_ids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmeasure.com/api/v1/companies/{company_id}/credits/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expiration_date\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"product_ids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"coupon_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"customer_id": "<string>",
"expiration_date": "2023-11-07T05:31:56Z",
"id": "<string>",
"import_created_at_ref": "2023-11-07T05:31:56Z",
"import_ref": "<string>",
"imported_from": "<string>",
"issued_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"issued_units": 123,
"item": {
"company_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"display_type": "<string>",
"editable": true,
"external_name": "<string>",
"id": "<string>",
"name": "<string>",
"standard": true,
"type": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"item_id": "<string>",
"metric_record_id": "<string>",
"name": "<string>",
"one_time_billable_id": "<string>",
"proration_date": "2023-11-07T05:31:56Z",
"restricted_product_ids": [
"<string>"
],
"state": "<string>",
"subscription_id": "<string>",
"type": "<string>",
"units": 123
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The idempotency key that will be used to ensure the request is only performed once
Path Parameters
The company ID with the prefix 'cmp_'.
The resource ID
Body
application/json
Response
200 - application/json
OK
The amount which has value in cents and a currency
Show child attributes
Show child attributes
The amount which has value in cents and a currency
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Update Credit
curl --request PATCH \
--url https://api.getmeasure.com/api/v1/companies/{company_id}/credits/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expiration_date": "2023-11-07T05:31:56Z",
"name": "<string>",
"product_ids": [
"<string>"
]
}
'import requests
url = "https://api.getmeasure.com/api/v1/companies/{company_id}/credits/{id}"
payload = {
"expiration_date": "2023-11-07T05:31:56Z",
"name": "<string>",
"product_ids": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expiration_date: '2023-11-07T05:31:56Z',
name: '<string>',
product_ids: ['<string>']
})
};
fetch('https://api.getmeasure.com/api/v1/companies/{company_id}/credits/{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://api.getmeasure.com/api/v1/companies/{company_id}/credits/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'expiration_date' => '2023-11-07T05:31:56Z',
'name' => '<string>',
'product_ids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.getmeasure.com/api/v1/companies/{company_id}/credits/{id}"
payload := strings.NewReader("{\n \"expiration_date\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"product_ids\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.getmeasure.com/api/v1/companies/{company_id}/credits/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expiration_date\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"product_ids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmeasure.com/api/v1/companies/{company_id}/credits/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expiration_date\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"product_ids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"coupon_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"customer_id": "<string>",
"expiration_date": "2023-11-07T05:31:56Z",
"id": "<string>",
"import_created_at_ref": "2023-11-07T05:31:56Z",
"import_ref": "<string>",
"imported_from": "<string>",
"issued_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"issued_units": 123,
"item": {
"company_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"display_type": "<string>",
"editable": true,
"external_name": "<string>",
"id": "<string>",
"name": "<string>",
"standard": true,
"type": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"item_id": "<string>",
"metric_record_id": "<string>",
"name": "<string>",
"one_time_billable_id": "<string>",
"proration_date": "2023-11-07T05:31:56Z",
"restricted_product_ids": [
"<string>"
],
"state": "<string>",
"subscription_id": "<string>",
"type": "<string>",
"units": 123
}
