Skip to main content
POST
/
companies
/
{company_id}
/
one_times
Create One-Time Charges
curl --request POST \
  --url https://api.getmeasure.com/api/v1/companies/{company_id}/one_times \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "<string>",
  "onetime_items": [
    {
      "aggregate": 123,
      "product_pricing_id": "<string>",
      "quantity_config": {
        "allow_custom_quantity": true,
        "max_quantity": 123,
        "min_quantity": 123
      },
      "sort_order": 123
    }
  ],
  "auto_charges": true,
  "discounts": [
    {
      "name": "<string>",
      "amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "cap": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "coupon_id": "<string>",
      "customer_id": "<string>",
      "expiration_date": "2023-11-07T05:31:56Z",
      "import_created_at_ref": "2023-11-07T05:31:56Z",
      "import_ref": "<string>",
      "imported_from": "<string>",
      "item_pricing_id": "<string>",
      "onetime_billable_id": "<string>",
      "percent": 0.5,
      "product_id": "<string>",
      "product_pricing_id": "<string>",
      "proposal_id": "<string>",
      "subscription_id": "<string>"
    }
  ],
  "invoice_date": "2023-11-07T05:31:56Z",
  "invoice_due_date_from_creation": 1,
  "invoice_payment_instructions": "<string>",
  "metadata": {},
  "notes": "<string>"
}
'
import requests

url = "https://api.getmeasure.com/api/v1/companies/{company_id}/one_times"

payload = {
"customer_id": "<string>",
"onetime_items": [
{
"aggregate": 123,
"product_pricing_id": "<string>",
"quantity_config": {
"allow_custom_quantity": True,
"max_quantity": 123,
"min_quantity": 123
},
"sort_order": 123
}
],
"auto_charges": True,
"discounts": [
{
"name": "<string>",
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"cap": {
"currency": "<string>",
"value_in_cents": 123
},
"coupon_id": "<string>",
"customer_id": "<string>",
"expiration_date": "2023-11-07T05:31:56Z",
"import_created_at_ref": "2023-11-07T05:31:56Z",
"import_ref": "<string>",
"imported_from": "<string>",
"item_pricing_id": "<string>",
"onetime_billable_id": "<string>",
"percent": 0.5,
"product_id": "<string>",
"product_pricing_id": "<string>",
"proposal_id": "<string>",
"subscription_id": "<string>"
}
],
"invoice_date": "2023-11-07T05:31:56Z",
"invoice_due_date_from_creation": 1,
"invoice_payment_instructions": "<string>",
"metadata": {},
"notes": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer_id: '<string>',
onetime_items: [
{
aggregate: 123,
product_pricing_id: '<string>',
quantity_config: {allow_custom_quantity: true, max_quantity: 123, min_quantity: 123},
sort_order: 123
}
],
auto_charges: true,
discounts: [
{
name: '<string>',
amount: {currency: '<string>', value_in_cents: 123},
cap: {currency: '<string>', value_in_cents: 123},
coupon_id: '<string>',
customer_id: '<string>',
expiration_date: '2023-11-07T05:31:56Z',
import_created_at_ref: '2023-11-07T05:31:56Z',
import_ref: '<string>',
imported_from: '<string>',
item_pricing_id: '<string>',
onetime_billable_id: '<string>',
percent: 0.5,
product_id: '<string>',
product_pricing_id: '<string>',
proposal_id: '<string>',
subscription_id: '<string>'
}
],
invoice_date: '2023-11-07T05:31:56Z',
invoice_due_date_from_creation: 1,
invoice_payment_instructions: '<string>',
metadata: {},
notes: '<string>'
})
};

fetch('https://api.getmeasure.com/api/v1/companies/{company_id}/one_times', 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}/one_times",
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([
'customer_id' => '<string>',
'onetime_items' => [
[
'aggregate' => 123,
'product_pricing_id' => '<string>',
'quantity_config' => [
'allow_custom_quantity' => true,
'max_quantity' => 123,
'min_quantity' => 123
],
'sort_order' => 123
]
],
'auto_charges' => true,
'discounts' => [
[
'name' => '<string>',
'amount' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'cap' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'coupon_id' => '<string>',
'customer_id' => '<string>',
'expiration_date' => '2023-11-07T05:31:56Z',
'import_created_at_ref' => '2023-11-07T05:31:56Z',
'import_ref' => '<string>',
'imported_from' => '<string>',
'item_pricing_id' => '<string>',
'onetime_billable_id' => '<string>',
'percent' => 0.5,
'product_id' => '<string>',
'product_pricing_id' => '<string>',
'proposal_id' => '<string>',
'subscription_id' => '<string>'
]
],
'invoice_date' => '2023-11-07T05:31:56Z',
'invoice_due_date_from_creation' => 1,
'invoice_payment_instructions' => '<string>',
'metadata' => [

],
'notes' => '<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}/one_times"

payload := strings.NewReader("{\n \"customer_id\": \"<string>\",\n \"onetime_items\": [\n {\n \"aggregate\": 123,\n \"product_pricing_id\": \"<string>\",\n \"quantity_config\": {\n \"allow_custom_quantity\": true,\n \"max_quantity\": 123,\n \"min_quantity\": 123\n },\n \"sort_order\": 123\n }\n ],\n \"auto_charges\": true,\n \"discounts\": [\n {\n \"name\": \"<string>\",\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"cap\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"coupon_id\": \"<string>\",\n \"customer_id\": \"<string>\",\n \"expiration_date\": \"2023-11-07T05:31:56Z\",\n \"import_created_at_ref\": \"2023-11-07T05:31:56Z\",\n \"import_ref\": \"<string>\",\n \"imported_from\": \"<string>\",\n \"item_pricing_id\": \"<string>\",\n \"onetime_billable_id\": \"<string>\",\n \"percent\": 0.5,\n \"product_id\": \"<string>\",\n \"product_pricing_id\": \"<string>\",\n \"proposal_id\": \"<string>\",\n \"subscription_id\": \"<string>\"\n }\n ],\n \"invoice_date\": \"2023-11-07T05:31:56Z\",\n \"invoice_due_date_from_creation\": 1,\n \"invoice_payment_instructions\": \"<string>\",\n \"metadata\": {},\n \"notes\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", 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.post("https://api.getmeasure.com/api/v1/companies/{company_id}/one_times")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customer_id\": \"<string>\",\n \"onetime_items\": [\n {\n \"aggregate\": 123,\n \"product_pricing_id\": \"<string>\",\n \"quantity_config\": {\n \"allow_custom_quantity\": true,\n \"max_quantity\": 123,\n \"min_quantity\": 123\n },\n \"sort_order\": 123\n }\n ],\n \"auto_charges\": true,\n \"discounts\": [\n {\n \"name\": \"<string>\",\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"cap\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"coupon_id\": \"<string>\",\n \"customer_id\": \"<string>\",\n \"expiration_date\": \"2023-11-07T05:31:56Z\",\n \"import_created_at_ref\": \"2023-11-07T05:31:56Z\",\n \"import_ref\": \"<string>\",\n \"imported_from\": \"<string>\",\n \"item_pricing_id\": \"<string>\",\n \"onetime_billable_id\": \"<string>\",\n \"percent\": 0.5,\n \"product_id\": \"<string>\",\n \"product_pricing_id\": \"<string>\",\n \"proposal_id\": \"<string>\",\n \"subscription_id\": \"<string>\"\n }\n ],\n \"invoice_date\": \"2023-11-07T05:31:56Z\",\n \"invoice_due_date_from_creation\": 1,\n \"invoice_payment_instructions\": \"<string>\",\n \"metadata\": {},\n \"notes\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.getmeasure.com/api/v1/companies/{company_id}/one_times")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_id\": \"<string>\",\n \"onetime_items\": [\n {\n \"aggregate\": 123,\n \"product_pricing_id\": \"<string>\",\n \"quantity_config\": {\n \"allow_custom_quantity\": true,\n \"max_quantity\": 123,\n \"min_quantity\": 123\n },\n \"sort_order\": 123\n }\n ],\n \"auto_charges\": true,\n \"discounts\": [\n {\n \"name\": \"<string>\",\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"cap\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"coupon_id\": \"<string>\",\n \"customer_id\": \"<string>\",\n \"expiration_date\": \"2023-11-07T05:31:56Z\",\n \"import_created_at_ref\": \"2023-11-07T05:31:56Z\",\n \"import_ref\": \"<string>\",\n \"imported_from\": \"<string>\",\n \"item_pricing_id\": \"<string>\",\n \"onetime_billable_id\": \"<string>\",\n \"percent\": 0.5,\n \"product_id\": \"<string>\",\n \"product_pricing_id\": \"<string>\",\n \"proposal_id\": \"<string>\",\n \"subscription_id\": \"<string>\"\n }\n ],\n \"invoice_date\": \"2023-11-07T05:31:56Z\",\n \"invoice_due_date_from_creation\": 1,\n \"invoice_payment_instructions\": \"<string>\",\n \"metadata\": {},\n \"notes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
[
  {
    "aggregate": 123,
    "company_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "custom_price": {
      "amount": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "product_id": "<string>",
      "description": "<string>"
    },
    "customer_id": "<string>",
    "id": "<string>",
    "name": "<string>",
    "product_pricing": {
      "company_id": "<string>",
      "computed_entitlements": [
        {
          "entitlement_id": "<string>",
          "id": "<string>",
          "inherited_from_id": "<string>",
          "inherited_from_type": "<string>",
          "key": "<string>",
          "name": "<string>",
          "original_value": "<unknown>",
          "overridden": true,
          "type": "<string>",
          "value": "<unknown>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "description": "<string>",
      "external_name": "<string>",
      "id": "<string>",
      "import_created_at_ref": "2023-11-07T05:31:56Z",
      "import_ref": "<string>",
      "imported_from": "<string>",
      "metadata": {},
      "minimum_spend": {
        "currency": "<string>",
        "value_in_cents": 123
      },
      "name": "<string>",
      "num_subs": 1,
      "override_entitlements": [
        {
          "entitlement_id": "<string>",
          "id": "<string>",
          "inherited_from_id": "<string>",
          "inherited_from_type": "<string>",
          "key": "<string>",
          "name": "<string>",
          "original_value": "<unknown>",
          "overridden": true,
          "type": "<string>",
          "value": "<unknown>"
        }
      ],
      "product": {
        "company_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "entitlements": [
          {
            "entitlement_id": "<string>",
            "id": "<string>",
            "inherited_from_id": "<string>",
            "inherited_from_type": "<string>",
            "key": "<string>",
            "name": "<string>",
            "original_value": "<unknown>",
            "overridden": true,
            "type": "<string>",
            "value": "<unknown>"
          }
        ],
        "external_name": "<string>",
        "gl_code": "<string>",
        "id": "<string>",
        "image_url": "<string>",
        "import_created_at_ref": "2023-11-07T05:31:56Z",
        "import_ref": "<string>",
        "imported_from": "<string>",
        "metadata": {},
        "name": "<string>",
        "num_subs": 1,
        "product_pricings": "<array>",
        "state": "<string>",
        "tags": [
          "<string>"
        ],
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "product_id": "<string>",
      "product_metric_pricings": [
        {
          "company_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "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>",
          "item_pricing": {
            "base_price": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "base_units": 123,
            "charge_type": "<string>",
            "company": {
              "address": {
                "address_line_1": "<string>",
                "address_line_2": "<string>",
                "city": "<string>",
                "country": "<string>",
                "place_id": "<string>",
                "state": "<string>",
                "zip": "<string>"
              },
              "computed_entitlements": {},
              "created_at": "2023-11-07T05:31:56Z",
              "customer_id": "<string>",
              "demo": true,
              "email": "<string>",
              "entitlements": [
                {
                  "entitlement_id": "<string>",
                  "id": "<string>",
                  "inherited_from_id": "<string>",
                  "inherited_from_type": "<string>",
                  "key": "<string>",
                  "name": "<string>",
                  "original_value": "<unknown>",
                  "overridden": true,
                  "type": "<string>",
                  "value": "<unknown>"
                }
              ],
              "id": "<string>",
              "is_dev": true,
              "legal_name": "<string>",
              "name": "<string>",
              "override_entitlements": [
                {
                  "entitlement_id": "<string>",
                  "id": "<string>",
                  "inherited_from_id": "<string>",
                  "inherited_from_type": "<string>",
                  "key": "<string>",
                  "name": "<string>",
                  "original_value": "<unknown>",
                  "overridden": true,
                  "type": "<string>",
                  "value": "<unknown>"
                }
              ],
              "phone": "<string>",
              "preferred_currency": "<string>",
              "preferred_timezone": "<string>",
              "slug": "<string>",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "company_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "credit_price": {
              "amount": {
                "currency": "<string>",
                "value_in_cents": 123
              },
              "item_id": "<string>",
              "scoped_product_ids": [
                "<string>"
              ],
              "units": 123
            },
            "custom_price": {
              "max_price_per_unit": 123,
              "min_price_per_unit": 123,
              "preset_price_per_unit": 123,
              "price_per_unit": 123
            },
            "description": "<string>",
            "display_type": "<string>",
            "editable": true,
            "external_name": "<string>",
            "fixed_price": {
              "price_per_unit": 123
            },
            "frequency": "<string>",
            "gradient_price": [
              {
                "end": 1,
                "flat_price": 123,
                "is_custom_tier": true,
                "price_per_unit": 123,
                "start": 1
              }
            ],
            "id": "<string>",
            "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>",
            "metadata": {},
            "minimum_spend": {
              "currency": "<string>",
              "value_in_cents": 123
            },
            "minimum_spend_schedule": {
              "allow_pulling_forward": true,
              "amount_per_period": [
                "<string>"
              ],
              "minimum_spend_schedule_type": "<string>"
            },
            "name": "<string>",
            "num_subs": 1,
            "proration_type": "<string>",
            "recognition_schedule": {
              "amount_per_period": [
                "<string>"
              ]
            },
            "scheduled_price": {
              "price_per_unit_per_period": [
                "<string>"
              ]
            },
            "state": "<string>",
            "step_price": {
              "price_per_step": 123,
              "step_size": 1
            },
            "term_count": 123,
            "true_up_frequency": "<string>",
            "type": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "volume_price": [
              {
                "flat_price": 123,
                "is_custom_tier": true,
                "price_per_unit": 123,
                "total_units_end": 1,
                "total_units_start": 1
              }
            ]
          },
          "item_pricing_id": "<string>",
          "metric": {
            "company_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "description": "<string>",
            "external_name": "<string>",
            "id": "<string>",
            "item_id": "<string>",
            "metering_rule": {
              "aggregator": "<string>",
              "group_keys": [
                "<string>"
              ],
              "property": "<string>",
              "rule": "<string>"
            },
            "name": "<string>",
            "standard": true,
            "type": "<string>",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "metric_id": "<string>",
          "product": {
            "company_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "description": "<string>",
            "entitlements": [
              {
                "entitlement_id": "<string>",
                "id": "<string>",
                "inherited_from_id": "<string>",
                "inherited_from_type": "<string>",
                "key": "<string>",
                "name": "<string>",
                "original_value": "<unknown>",
                "overridden": true,
                "type": "<string>",
                "value": "<unknown>"
              }
            ],
            "external_name": "<string>",
            "gl_code": "<string>",
            "id": "<string>",
            "image_url": "<string>",
            "import_created_at_ref": "2023-11-07T05:31:56Z",
            "import_ref": "<string>",
            "imported_from": "<string>",
            "metadata": {},
            "name": "<string>",
            "num_subs": 1,
            "product_pricings": "<array>",
            "state": "<string>",
            "tags": [
              "<string>"
            ],
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "product_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "state": "<string>",
      "tags": [
        "<string>"
      ],
      "type": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "upsell_product_pricing_id": "<string>"
    },
    "product_pricing_id": "<string>",
    "quantity_config": {
      "allow_custom_quantity": true,
      "max_quantity": 123,
      "min_quantity": 123
    },
    "sort_order": 123,
    "state": "<string>",
    "type": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

company_id
string
required

The company ID with the prefix 'cmp_'.

Body

application/json
customer_id
string
required

The customer to whom the one-time charges belong

onetime_items
object[]
required

The list of one-time charges

type
enum<string>
required

The type of one-time charges which can be IMMEDIATE or NEXT depending on whether they are invoiced immediately or on the next invoice for the customer

Available options:
IMMEDIATE,
NEXT
auto_charges
null | boolean

Whether the one-time charges are automatically charged to the payment method for the customer

discounts
object[] | null

The discounts attached to the one-time charges

invoice_date
null | string<date-time>

The date of invoice for the customer

invoice_due_date_from_creation
null | integer

Number of days before the invoice is due (from the invoice date)

Required range: x >= 0
invoice_payment_instructions
string | null

The payment instructions for the customer

metadata
object

Any additional data as key-value pairs attached to the charge

notes
null | string

The notes attached to the one-time charges

Response

201 - application/json

Created

aggregate
number<double>
company_id
string
created_at
string<date-time>
custom_price
object
customer_id
null | string
id
string
name
string
product_pricing
object
product_pricing_id
null | string
quantity_config
object
sort_order
null | number
state
string
type
string
updated_at
string<date-time>