Create Benefit Grant

POST

benefit-grants

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.benefit_grants.create(
    customer_id='992fae2a-2a17-4b7a-8d9e-e287cf90131b',
    benefit_id='397a17aa-15cf-4cb4-9333-18040203cf98',
)
print(response)

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

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

const response = await polar.benefitGrants.create(
  {
    "customer_id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    "benefit_id": "397a17aa-15cf-4cb4-9333-18040203cf98"
  },
);
console.log(response);

curl --request POST \
  --url https://api.polar.sh/v1/benefit-grants/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
  "benefit_id": "397a17aa-15cf-4cb4-9333-18040203cf98",
  "member_id": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer_id: '992fae2a-2a17-4b7a-8d9e-e287cf90131b',
    benefit_id: '397a17aa-15cf-4cb4-9333-18040203cf98',
    member_id: '<string>'
  })
};

fetch('https://api.polar.sh/v1/benefit-grants/', 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/benefit-grants/",
  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' => '992fae2a-2a17-4b7a-8d9e-e287cf90131b',
    'benefit_id' => '397a17aa-15cf-4cb4-9333-18040203cf98',
    'member_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/benefit-grants/"

	payload := strings.NewReader("{\n  \"customer_id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n  \"benefit_id\": \"397a17aa-15cf-4cb4-9333-18040203cf98\",\n  \"member_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/benefit-grants/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n  \"benefit_id\": \"397a17aa-15cf-4cb4-9333-18040203cf98\",\n  \"member_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/benefit-grants/")

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\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n  \"benefit_id\": \"397a17aa-15cf-4cb4-9333-18040203cf98\",\n  \"member_id\": \"<string>\"\n}"

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

{
  "manually_granted_at": "2026-01-01T00:00:00.000000Z",
  "manually_revoked_at": "2026-01-01T00:00:00.000000Z",
  "created_at": "2026-01-01T00:00:00.000000Z",
  "modified_at": "2026-01-01T00:00:00.000000Z",
  "id": "<string>",
  "is_granted": true,
  "is_revoked": true,
  "subscription_id": "<string>",
  "order_id": "<string>",
  "customer_id": "<string>",
  "benefit_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>"
  },
  "benefit": {
    "id": "<string>",
    "created_at": "2026-01-01T00:00:00.000000Z",
    "modified_at": "2026-01-01T00:00:00.000000Z",
    "type": "custom",
    "description": "<string>",
    "selectable": true,
    "deletable": true,
    "is_deleted": true,
    "organization_id": "<string>",
    "external_id": "ext_1337",
    "metadata": {},
    "visibility": "draft",
    "catalog_id": "<string>",
    "is_current": true,
    "properties": {
      "note": "<string>"
    },
    "visibility_configurable": true
  },
  "properties": {
    "account_id": "<string>",
    "guild_id": "<string>",
    "role_id": "<string>",
    "granted_account_id": "<string>"
  },
  "granted_at": "2026-01-01T00:00:00.000000Z",
  "revoked_at": "2026-01-01T00:00:00.000000Z",
  "member_id": "<string>",
  "error": {
    "message": "<string>",
    "type": "<string>",
    "timestamp": "<string>"
  },
  "member": {
    "id": "<string>",
    "created_at": "2026-01-01T00:00:00.000000Z",
    "modified_at": "2026-01-01T00:00:00.000000Z",
    "customer_id": "<string>",
    "email": "[email protected]",
    "name": "Jane Doe",
    "external_id": "usr_1337",
    "role": "owner"
  }
}

{
  "error": "BenefitGrantAlreadyExists",
  "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

benefits:write

pat

benefits:write

oat

Body

application/json

BenefitGrantCreate
BenefitGrantCreateExternal

Manually grant a benefit using Polar IDs.

customer_id

string<uuid4>

required

The ID of the customer.

Example:

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

benefit_id

string<uuid4>

required

The ID of the benefit.

Example:

"397a17aa-15cf-4cb4-9333-18040203cf98"

member_id

string<uuid4> | null

The ID of the member receiving the benefit. If not provided, the benefit is granted to the customer's owner.

Response

Successful Response

manually_granted_at

string<date-time> | null

required

When the manual grant was requested, if applicable.

Example:

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

manually_revoked_at

string<date-time> | null

required

When this grant was permanently revoked manually, if applicable.

Example:

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

created_at

string<date-time>

required

Creation timestamp of the object.

Example:

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

modified_at

string<date-time> | null

required

Last modification timestamp of the object.

Example:

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

string<uuid4>

required

The ID of the grant.

is_granted

boolean

required

Whether the benefit is granted.

is_revoked

boolean

required

Whether the benefit is revoked.

subscription_id

string<uuid4> | null

required

The ID of the subscription that granted this benefit.

order_id

string<uuid4> | null

required

The ID of the order that granted this benefit.

customer_id

string<uuid4>

required

The ID of the customer concerned by this grant.

benefit_id

string<uuid4>

required

The ID of the benefit concerned by this grant.

customer

CustomerIndividual · object

required

A customer in an organization.

CustomerIndividual
CustomerTeam

Show child attributes

benefit

BenefitCustom · object

required

A benefit of type custom.

Use it to grant any kind of benefit that doesn't fit in the other types.

Show child attributes

properties

BenefitGrantDiscordProperties · object

required

BenefitGrantDiscordProperties
BenefitGrantGitHubRepositoryProperties
BenefitGrantDownloadablesProperties
BenefitGrantLicenseKeysProperties
BenefitGrantCustomProperties
BenefitGrantFeatureFlagProperties
BenefitGrantSlackSharedChannelProperties

Show child attributes

granted_at

string<date-time> | null

The timestamp when the benefit was granted. If None, the benefit is not granted.

Example:

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

revoked_at

string<date-time> | null

The timestamp when the benefit was revoked. If None, the benefit is not revoked.

Example:

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

member_id

string<uuid4> | null

The ID of the member concerned by this grant.

error

BenefitGrantError · object | null

The error information if the benefit grant failed with an unrecoverable error.

Show child attributes

member

Member · object | null

A member of a customer.

Show child attributes

⌘I

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.benefit_grants.create(
    customer_id='992fae2a-2a17-4b7a-8d9e-e287cf90131b',
    benefit_id='397a17aa-15cf-4cb4-9333-18040203cf98',
)
print(response)

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

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

const response = await polar.benefitGrants.create(
  {
    "customer_id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    "benefit_id": "397a17aa-15cf-4cb4-9333-18040203cf98"
  },
);
console.log(response);

curl --request POST \
  --url https://api.polar.sh/v1/benefit-grants/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
  "benefit_id": "397a17aa-15cf-4cb4-9333-18040203cf98",
  "member_id": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer_id: '992fae2a-2a17-4b7a-8d9e-e287cf90131b',
    benefit_id: '397a17aa-15cf-4cb4-9333-18040203cf98',
    member_id: '<string>'
  })
};

fetch('https://api.polar.sh/v1/benefit-grants/', 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/benefit-grants/",
  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' => '992fae2a-2a17-4b7a-8d9e-e287cf90131b',
    'benefit_id' => '397a17aa-15cf-4cb4-9333-18040203cf98',
    'member_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/benefit-grants/"

	payload := strings.NewReader("{\n  \"customer_id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n  \"benefit_id\": \"397a17aa-15cf-4cb4-9333-18040203cf98\",\n  \"member_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/benefit-grants/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n  \"benefit_id\": \"397a17aa-15cf-4cb4-9333-18040203cf98\",\n  \"member_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/benefit-grants/")

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\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n  \"benefit_id\": \"397a17aa-15cf-4cb4-9333-18040203cf98\",\n  \"member_id\": \"<string>\"\n}"

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

{
  "manually_granted_at": "2026-01-01T00:00:00.000000Z",
  "manually_revoked_at": "2026-01-01T00:00:00.000000Z",
  "created_at": "2026-01-01T00:00:00.000000Z",
  "modified_at": "2026-01-01T00:00:00.000000Z",
  "id": "<string>",
  "is_granted": true,
  "is_revoked": true,
  "subscription_id": "<string>",
  "order_id": "<string>",
  "customer_id": "<string>",
  "benefit_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>"
  },
  "benefit": {
    "id": "<string>",
    "created_at": "2026-01-01T00:00:00.000000Z",
    "modified_at": "2026-01-01T00:00:00.000000Z",
    "type": "custom",
    "description": "<string>",
    "selectable": true,
    "deletable": true,
    "is_deleted": true,
    "organization_id": "<string>",
    "external_id": "ext_1337",
    "metadata": {},
    "visibility": "draft",
    "catalog_id": "<string>",
    "is_current": true,
    "properties": {
      "note": "<string>"
    },
    "visibility_configurable": true
  },
  "properties": {
    "account_id": "<string>",
    "guild_id": "<string>",
    "role_id": "<string>",
    "granted_account_id": "<string>"
  },
  "granted_at": "2026-01-01T00:00:00.000000Z",
  "revoked_at": "2026-01-01T00:00:00.000000Z",
  "member_id": "<string>",
  "error": {
    "message": "<string>",
    "type": "<string>",
    "timestamp": "<string>"
  },
  "member": {
    "id": "<string>",
    "created_at": "2026-01-01T00:00:00.000000Z",
    "modified_at": "2026-01-01T00:00:00.000000Z",
    "customer_id": "<string>",
    "email": "[email protected]",
    "name": "Jane Doe",
    "external_id": "usr_1337",
    "role": "owner"
  }
}

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

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

General

Core API

Customer Portal API

Webhook Events

Integrations

Create Benefit Grant

Authorizations

Scopes

Body

Response