Credit Customer Meter

POST

customer-meters

credits

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.customer_meters.credits(
    units=100,
    rollover=False,
    customer_id='992fae2a-2a17-4b7a-8d9e-e287cf90131b',
    meter_id='d498a884-e2cd-4d3e-8002-f536468a8b22',
)
print(response)

import { createPolar } from "@polar-sh/sdk/2027-01";

const polar = createPolar({
  accessToken: "polar_oat_xxx",
});

const response = await polar.customerMeters.credits(
  {
    "units": 100,
    "rollover": false,
    "customer_id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22"
  },
);
console.log(response);

curl --request POST \
  --url https://api.polar.sh/v1/customer-meters/credits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "units": 100,
  "customer_id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
  "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22",
  "rollover": false,
  "external_id": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    units: 100,
    customer_id: '992fae2a-2a17-4b7a-8d9e-e287cf90131b',
    meter_id: 'd498a884-e2cd-4d3e-8002-f536468a8b22',
    rollover: false,
    external_id: '<string>'
  })
};

fetch('https://api.polar.sh/v1/customer-meters/credits', 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.polar.sh/v1/customer-meters/credits",
  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([
    'units' => 100,
    'customer_id' => '992fae2a-2a17-4b7a-8d9e-e287cf90131b',
    'meter_id' => 'd498a884-e2cd-4d3e-8002-f536468a8b22',
    'rollover' => false,
    'external_id' => '<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.polar.sh/v1/customer-meters/credits"

	payload := strings.NewReader("{\n  \"units\": 100,\n  \"customer_id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n  \"meter_id\": \"d498a884-e2cd-4d3e-8002-f536468a8b22\",\n  \"rollover\": false,\n  \"external_id\": \"<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.polar.sh/v1/customer-meters/credits")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"units\": 100,\n  \"customer_id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n  \"meter_id\": \"d498a884-e2cd-4d3e-8002-f536468a8b22\",\n  \"rollover\": false,\n  \"external_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/customer-meters/credits")

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  \"units\": 100,\n  \"customer_id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n  \"meter_id\": \"d498a884-e2cd-4d3e-8002-f536468a8b22\",\n  \"rollover\": false,\n  \"external_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "timestamp": "2026-01-01T00:00:00.000000Z",
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "customer_id": "<string>",
  "customer": {
    "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    "created_at": "2026-01-01T00:00:00.000000Z",
    "modified_at": "2026-01-01T00:00:00.000000Z",
    "metadata": {},
    "email": "[email protected]",
    "email_verified": true,
    "type": "individual",
    "name": "John Doe",
    "billing_name": "John Doe",
    "billing_address": {
      "country": "US",
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>"
    },
    "tax_id": {
      "[0]": "<string>"
    },
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    "deleted_at": "2026-01-01T00:00:00.000000Z",
    "first_user_event_at": "2026-01-01T00:00:00.000000Z",
    "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404",
    "external_id": "usr_1337",
    "locale": "<string>",
    "default_payment_method_id": "<string>"
  },
  "external_customer_id": "<string>",
  "label": "<string>",
  "source": "system",
  "name": "meter.credited",
  "metadata": {
    "meter_id": "<string>",
    "units": 123,
    "rollover": true,
    "reason": "benefit"
  },
  "member_id": "<string>",
  "external_member_id": "<string>",
  "child_count": 0,
  "parent_id": "<string>"
}

{
  "error": "NotPermitted",
  "detail": "<string>"
}

{
  "error": "CustomerMeterCreditExternalIDConflict",
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

You can generate a Personal Access Token from your settings.

Scopes

customers:write

pat

customers:write

oat

Body

application/json

CustomerMeterCreditsIDCreate
CustomerMeterCreditsExternalIDCreate

Schema to manually grant credits on a customer meter using Polar IDs.

units

integer

required

The number of units to credit.

Required range: x <= 1000000000

Example:

100

customer_id

string<uuid4>

required

The ID of the customer.

Example:

"992fae2a-2a17-4b7a-8d9e-e287cf90131b"

meter_id

string<uuid4>

required

The ID of the meter.

Example:

"d498a884-e2cd-4d3e-8002-f536468a8b22"

rollover

boolean

default:false

Whether unused credits carry over to the next meter period.

external_id

string | null

Your unique identifier for this credit. Retrying with the same external_id doesn't grant the credit twice.

Minimum string length: 1

Response

Credit recorded and the customer meter balance updated. If the meter is being updated concurrently, the balance catches up shortly after.

An event created by Polar when credits are added to a customer meter.

string<uuid4>

required

The ID of the object.

timestamp

string<date-time>

required

The timestamp of the event.

Example:

"2026-01-01T00:00:00.000000Z"

organization_id

string<uuid4>

required

The ID of the organization owning the event.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

customer_id

string<uuid4> | null

required

ID of the customer in your Polar organization associated with the event.

customer

CustomerIndividual · object

required

The customer associated with the event.

CustomerIndividual
CustomerTeam

Show child attributes

external_customer_id

string | null

required

ID of the customer in your system associated with the event.

label

string

required

Human readable label of the event type.

source

string

required

The source of the event. system events are created by Polar. user events are the one you create through our ingestion API.

Allowed value: "system"

name

string

required

The name of the event.

Allowed value: "meter.credited"

metadata

MeterCreditedMetadata · object

required

Show child attributes

member_id

string<uuid4> | null

ID of the member within the customer's organization who performed the action inside B2B.

external_member_id

string | null

ID of the member in your system within the customer's organization who performed the action inside B2B.

child_count

integer

default:0

Number of direct child events linked to this event.

parent_id

string<uuid4> | null

The ID of the parent event.

⌘I

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.customer_meters.credits(
    units=100,
    rollover=False,
    customer_id='992fae2a-2a17-4b7a-8d9e-e287cf90131b',
    meter_id='d498a884-e2cd-4d3e-8002-f536468a8b22',
)
print(response)

import { createPolar } from "@polar-sh/sdk/2027-01";

const polar = createPolar({
  accessToken: "polar_oat_xxx",
});

const response = await polar.customerMeters.credits(
  {
    "units": 100,
    "rollover": false,
    "customer_id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22"
  },
);
console.log(response);

curl --request POST \
  --url https://api.polar.sh/v1/customer-meters/credits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "units": 100,
  "customer_id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
  "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22",
  "rollover": false,
  "external_id": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    units: 100,
    customer_id: '992fae2a-2a17-4b7a-8d9e-e287cf90131b',
    meter_id: 'd498a884-e2cd-4d3e-8002-f536468a8b22',
    rollover: false,
    external_id: '<string>'
  })
};

fetch('https://api.polar.sh/v1/customer-meters/credits', 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.polar.sh/v1/customer-meters/credits",
  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([
    'units' => 100,
    'customer_id' => '992fae2a-2a17-4b7a-8d9e-e287cf90131b',
    'meter_id' => 'd498a884-e2cd-4d3e-8002-f536468a8b22',
    'rollover' => false,
    'external_id' => '<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.polar.sh/v1/customer-meters/credits"

	payload := strings.NewReader("{\n  \"units\": 100,\n  \"customer_id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n  \"meter_id\": \"d498a884-e2cd-4d3e-8002-f536468a8b22\",\n  \"rollover\": false,\n  \"external_id\": \"<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.polar.sh/v1/customer-meters/credits")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"units\": 100,\n  \"customer_id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n  \"meter_id\": \"d498a884-e2cd-4d3e-8002-f536468a8b22\",\n  \"rollover\": false,\n  \"external_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/customer-meters/credits")

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  \"units\": 100,\n  \"customer_id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n  \"meter_id\": \"d498a884-e2cd-4d3e-8002-f536468a8b22\",\n  \"rollover\": false,\n  \"external_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "timestamp": "2026-01-01T00:00:00.000000Z",
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "customer_id": "<string>",
  "customer": {
    "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    "created_at": "2026-01-01T00:00:00.000000Z",
    "modified_at": "2026-01-01T00:00:00.000000Z",
    "metadata": {},
    "email": "[email protected]",
    "email_verified": true,
    "type": "individual",
    "name": "John Doe",
    "billing_name": "John Doe",
    "billing_address": {
      "country": "US",
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>"
    },
    "tax_id": {
      "[0]": "<string>"
    },
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    "deleted_at": "2026-01-01T00:00:00.000000Z",
    "first_user_event_at": "2026-01-01T00:00:00.000000Z",
    "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404",
    "external_id": "usr_1337",
    "locale": "<string>",
    "default_payment_method_id": "<string>"
  },
  "external_customer_id": "<string>",
  "label": "<string>",
  "source": "system",
  "name": "meter.credited",
  "metadata": {
    "meter_id": "<string>",
    "units": 123,
    "rollover": true,
    "reason": "benefit"
  },
  "member_id": "<string>",
  "external_member_id": "<string>",
  "child_count": 0,
  "parent_id": "<string>"
}

{
  "error": "NotPermitted",
  "detail": "<string>"
}

{
  "error": "CustomerMeterCreditExternalIDConflict",
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

General

Core API

Customer Portal API

Webhook Events

Integrations

Credit Customer Meter

Authorizations

Scopes

Body

Response