> ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create Benefit > Create a benefit. **Scopes**: `benefits:write` ## OpenAPI ````yaml post /v1/benefits/ openapi: 3.1.0 info: title: Polar API summary: Polar HTTP and Webhooks API description: Read the docs at https://polar.sh/docs/api-reference version: 0.1.0 servers: - url: https://api.polar.sh description: Production environment x-speakeasy-server-id: production - url: https://sandbox-api.polar.sh description: Sandbox environment x-speakeasy-server-id: sandbox security: - access_token: [] tags: - name: public description: >- Endpoints shown and documented in the Polar API documentation and available in our SDKs. - name: private description: >- Endpoints that should appear in the schema only in development to generate our internal JS SDK. - name: mcp description: Endpoints enabled in the MCP server. paths: /v1/benefits/: post: tags: - benefits - public summary: Create Benefit description: |- Create a benefit. **Scopes**: `benefits:write` operationId: benefits:create requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BenefitCreate' responses: '201': description: Benefit created. content: application/json: schema: $ref: '#/components/schemas/Benefit' title: Benefit '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-codeSamples: - lang: go label: Go (SDK) source: "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tpolargo \"github.com/polarsource/polar-go\"\n\t\"github.com/polarsource/polar-go/models/components\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := polargo.New(\n polargo.WithSecurity(os.Getenv(\"POLAR_ACCESS_TOKEN\")),\n )\n\n res, err := s.Benefits.Create(ctx, components.CreateBenefitCreateLicenseKeys(\n components.BenefitLicenseKeysCreate{\n Description: \"mature emergent at outside arrogantly gadzooks zealous equatorial notwithstanding\",\n OrganizationID: polargo.Pointer(\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\"),\n Properties: components.BenefitLicenseKeysCreateProperties{},\n },\n ))\n if err != nil {\n log.Fatal(err)\n }\n if res.Benefit != nil {\n switch res.Benefit.Type {\n case components.BenefitUnionTypeCustom:\n // res.Benefit.BenefitCustom is populated\n case components.BenefitUnionTypeDiscord:\n // res.Benefit.BenefitDiscord is populated\n case components.BenefitUnionTypeDownloadables:\n // res.Benefit.BenefitDownloadables is populated\n case components.BenefitUnionTypeFeatureFlag:\n // res.Benefit.BenefitFeatureFlag is populated\n case components.BenefitUnionTypeGithubRepository:\n // res.Benefit.BenefitGitHubRepository is populated\n case components.BenefitUnionTypeLicenseKeys:\n // res.Benefit.BenefitLicenseKeys is populated\n case components.BenefitUnionTypeMeterCredit:\n // res.Benefit.BenefitMeterCredit is populated\n }\n\n }\n}" - lang: python label: Python (SDK) source: |- from polar_sdk import Polar with Polar( access_token="", ) as polar: res = polar.benefits.create(request={ "type": "license_keys", "description": "mature emergent at outside arrogantly gadzooks zealous equatorial notwithstanding", "properties": {}, }) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { Polar } from "@polar-sh/sdk"; const polar = new Polar({ accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "", }); async function run() { const result = await polar.benefits.create({ type: "license_keys", description: "mature emergent at outside arrogantly gadzooks zealous equatorial notwithstanding", organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737", properties: {}, }); console.log(result); } run(); - lang: php label: PHP (SDK) source: |- declare(strict_types=1); require 'vendor/autoload.php'; use Polar; use Polar\Models\Components; $sdk = Polar\Polar::builder() ->setSecurity( '' ) ->build(); $request = new Components\BenefitLicenseKeysCreate( description: 'mature emergent at outside arrogantly gadzooks zealous equatorial notwithstanding', organizationId: '1dbfc517-0bbf-4301-9ba8-555ca42b9737', properties: new Components\BenefitLicenseKeysCreateProperties(), ); $response = $sdk->benefits->create( request: $request ); if ($response->benefit !== null) { // handle response } components: schemas: BenefitCreate: oneOf: - $ref: '#/components/schemas/BenefitCustomCreate' - $ref: '#/components/schemas/BenefitDiscordCreate' - $ref: '#/components/schemas/BenefitGitHubRepositoryCreate' - $ref: '#/components/schemas/BenefitDownloadablesCreate' - $ref: '#/components/schemas/BenefitLicenseKeysCreate' - $ref: '#/components/schemas/BenefitMeterCreditCreate' - $ref: '#/components/schemas/BenefitFeatureFlagCreate' discriminator: propertyName: type mapping: custom: $ref: '#/components/schemas/BenefitCustomCreate' discord: $ref: '#/components/schemas/BenefitDiscordCreate' downloadables: $ref: '#/components/schemas/BenefitDownloadablesCreate' feature_flag: $ref: '#/components/schemas/BenefitFeatureFlagCreate' github_repository: $ref: '#/components/schemas/BenefitGitHubRepositoryCreate' license_keys: $ref: '#/components/schemas/BenefitLicenseKeysCreate' meter_credit: $ref: '#/components/schemas/BenefitMeterCreditCreate' Benefit: oneOf: - $ref: '#/components/schemas/BenefitCustom' - $ref: '#/components/schemas/BenefitDiscord' - $ref: '#/components/schemas/BenefitGitHubRepository' - $ref: '#/components/schemas/BenefitDownloadables' - $ref: '#/components/schemas/BenefitLicenseKeys' - $ref: '#/components/schemas/BenefitMeterCredit' - $ref: '#/components/schemas/BenefitFeatureFlag' discriminator: propertyName: type mapping: custom: $ref: '#/components/schemas/BenefitCustom' discord: $ref: '#/components/schemas/BenefitDiscord' downloadables: $ref: '#/components/schemas/BenefitDownloadables' feature_flag: $ref: '#/components/schemas/BenefitFeatureFlag' github_repository: $ref: '#/components/schemas/BenefitGitHubRepository' license_keys: $ref: '#/components/schemas/BenefitLicenseKeys' meter_credit: $ref: '#/components/schemas/BenefitMeterCredit' HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError BenefitCustomCreate: properties: metadata: additionalProperties: anyOf: - type: string maxLength: 500 minLength: 1 - type: integer - type: number - type: boolean propertyNames: maxLength: 40 minLength: 1 type: object maxProperties: 50 title: Metadata description: |- Key-value object allowing you to store additional information. The key must be a string with a maximum length of **40 characters**. The value must be either: * A string with a maximum length of **500 characters** * An integer * A floating-point number * A boolean You can store up to **50 key-value pairs**. type: type: string const: custom title: Type description: type: string maxLength: 42 minLength: 3 title: Description description: >- The description of the benefit. Will be displayed on products having this benefit. organization_id: anyOf: - type: string format: uuid4 description: The organization ID. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-polar-selector-widget: displayProperty: name resourceName: Organization resourceRoot: /v1/organizations - type: 'null' title: Organization Id description: >- The ID of the organization owning the benefit. **Required unless you use an organization token.** properties: $ref: '#/components/schemas/BenefitCustomCreateProperties' type: object required: - type - description - properties title: BenefitCustomCreate description: Schema to create a benefit of type `custom`. BenefitDiscordCreate: properties: metadata: additionalProperties: anyOf: - type: string maxLength: 500 minLength: 1 - type: integer - type: number - type: boolean propertyNames: maxLength: 40 minLength: 1 type: object maxProperties: 50 title: Metadata description: |- Key-value object allowing you to store additional information. The key must be a string with a maximum length of **40 characters**. The value must be either: * A string with a maximum length of **500 characters** * An integer * A floating-point number * A boolean You can store up to **50 key-value pairs**. type: type: string const: discord title: Type description: type: string maxLength: 42 minLength: 3 title: Description description: >- The description of the benefit. Will be displayed on products having this benefit. organization_id: anyOf: - type: string format: uuid4 description: The organization ID. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-polar-selector-widget: displayProperty: name resourceName: Organization resourceRoot: /v1/organizations - type: 'null' title: Organization Id description: >- The ID of the organization owning the benefit. **Required unless you use an organization token.** properties: $ref: '#/components/schemas/BenefitDiscordCreateProperties' type: object required: - type - description - properties title: BenefitDiscordCreate BenefitGitHubRepositoryCreate: properties: metadata: additionalProperties: anyOf: - type: string maxLength: 500 minLength: 1 - type: integer - type: number - type: boolean propertyNames: maxLength: 40 minLength: 1 type: object maxProperties: 50 title: Metadata description: |- Key-value object allowing you to store additional information. The key must be a string with a maximum length of **40 characters**. The value must be either: * A string with a maximum length of **500 characters** * An integer * A floating-point number * A boolean You can store up to **50 key-value pairs**. type: type: string const: github_repository title: Type description: type: string maxLength: 42 minLength: 3 title: Description description: >- The description of the benefit. Will be displayed on products having this benefit. organization_id: anyOf: - type: string format: uuid4 description: The organization ID. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-polar-selector-widget: displayProperty: name resourceName: Organization resourceRoot: /v1/organizations - type: 'null' title: Organization Id description: >- The ID of the organization owning the benefit. **Required unless you use an organization token.** properties: $ref: '#/components/schemas/BenefitGitHubRepositoryCreateProperties' type: object required: - type - description - properties title: BenefitGitHubRepositoryCreate BenefitDownloadablesCreate: properties: metadata: additionalProperties: anyOf: - type: string maxLength: 500 minLength: 1 - type: integer - type: number - type: boolean propertyNames: maxLength: 40 minLength: 1 type: object maxProperties: 50 title: Metadata description: |- Key-value object allowing you to store additional information. The key must be a string with a maximum length of **40 characters**. The value must be either: * A string with a maximum length of **500 characters** * An integer * A floating-point number * A boolean You can store up to **50 key-value pairs**. type: type: string const: downloadables title: Type description: type: string maxLength: 42 minLength: 3 title: Description description: >- The description of the benefit. Will be displayed on products having this benefit. organization_id: anyOf: - type: string format: uuid4 description: The organization ID. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-polar-selector-widget: displayProperty: name resourceName: Organization resourceRoot: /v1/organizations - type: 'null' title: Organization Id description: >- The ID of the organization owning the benefit. **Required unless you use an organization token.** properties: $ref: '#/components/schemas/BenefitDownloadablesCreateProperties' type: object required: - type - description - properties title: BenefitDownloadablesCreate BenefitLicenseKeysCreate: properties: metadata: additionalProperties: anyOf: - type: string maxLength: 500 minLength: 1 - type: integer - type: number - type: boolean propertyNames: maxLength: 40 minLength: 1 type: object maxProperties: 50 title: Metadata description: |- Key-value object allowing you to store additional information. The key must be a string with a maximum length of **40 characters**. The value must be either: * A string with a maximum length of **500 characters** * An integer * A floating-point number * A boolean You can store up to **50 key-value pairs**. type: type: string const: license_keys title: Type description: type: string maxLength: 42 minLength: 3 title: Description description: >- The description of the benefit. Will be displayed on products having this benefit. organization_id: anyOf: - type: string format: uuid4 description: The organization ID. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-polar-selector-widget: displayProperty: name resourceName: Organization resourceRoot: /v1/organizations - type: 'null' title: Organization Id description: >- The ID of the organization owning the benefit. **Required unless you use an organization token.** properties: $ref: '#/components/schemas/BenefitLicenseKeysCreateProperties' type: object required: - type - description - properties title: BenefitLicenseKeysCreate BenefitMeterCreditCreate: properties: metadata: additionalProperties: anyOf: - type: string maxLength: 500 minLength: 1 - type: integer - type: number - type: boolean propertyNames: maxLength: 40 minLength: 1 type: object maxProperties: 50 title: Metadata description: |- Key-value object allowing you to store additional information. The key must be a string with a maximum length of **40 characters**. The value must be either: * A string with a maximum length of **500 characters** * An integer * A floating-point number * A boolean You can store up to **50 key-value pairs**. type: type: string const: meter_credit title: Type description: type: string maxLength: 42 minLength: 3 title: Description description: >- The description of the benefit. Will be displayed on products having this benefit. organization_id: anyOf: - type: string format: uuid4 description: The organization ID. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-polar-selector-widget: displayProperty: name resourceName: Organization resourceRoot: /v1/organizations - type: 'null' title: Organization Id description: >- The ID of the organization owning the benefit. **Required unless you use an organization token.** properties: $ref: '#/components/schemas/BenefitMeterCreditCreateProperties' type: object required: - type - description - properties title: BenefitMeterCreditCreate description: Schema to create a benefit of type `meter_unit`. BenefitFeatureFlagCreate: properties: metadata: additionalProperties: anyOf: - type: string maxLength: 500 minLength: 1 - type: integer - type: number - type: boolean propertyNames: maxLength: 40 minLength: 1 type: object maxProperties: 50 title: Metadata description: |- Key-value object allowing you to store additional information. The key must be a string with a maximum length of **40 characters**. The value must be either: * A string with a maximum length of **500 characters** * An integer * A floating-point number * A boolean You can store up to **50 key-value pairs**. type: type: string const: feature_flag title: Type description: type: string maxLength: 42 minLength: 3 title: Description description: >- The description of the benefit. Will be displayed on products having this benefit. organization_id: anyOf: - type: string format: uuid4 description: The organization ID. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-polar-selector-widget: displayProperty: name resourceName: Organization resourceRoot: /v1/organizations - type: 'null' title: Organization Id description: >- The ID of the organization owning the benefit. **Required unless you use an organization token.** properties: $ref: '#/components/schemas/BenefitFeatureFlagCreateProperties' type: object required: - type - description - properties title: BenefitFeatureFlagCreate description: Schema to create a benefit of type `feature_flag`. BenefitCustom: properties: id: type: string format: uuid4 title: Id description: The ID of the benefit. created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. type: type: string const: custom title: Type description: type: string title: Description description: The description of the benefit. selectable: type: boolean title: Selectable description: Whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' properties: $ref: '#/components/schemas/BenefitCustomProperties' type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - properties title: BenefitCustom description: |- A benefit of type `custom`. Use it to grant any kind of benefit that doesn't fit in the other types. BenefitDiscord: properties: id: type: string format: uuid4 title: Id description: The ID of the benefit. created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. type: type: string const: discord title: Type description: type: string title: Description description: The description of the benefit. selectable: type: boolean title: Selectable description: Whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' properties: $ref: '#/components/schemas/BenefitDiscordProperties' type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - properties title: BenefitDiscord description: |- A benefit of type `discord`. Use it to automatically invite your backers to a Discord server. BenefitGitHubRepository: properties: id: type: string format: uuid4 title: Id description: The ID of the benefit. created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. type: type: string const: github_repository title: Type description: type: string title: Description description: The description of the benefit. selectable: type: boolean title: Selectable description: Whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' properties: $ref: '#/components/schemas/BenefitGitHubRepositoryProperties' type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - properties title: BenefitGitHubRepository description: >- A benefit of type `github_repository`. Use it to automatically invite your backers to a private GitHub repository. BenefitDownloadables: properties: id: type: string format: uuid4 title: Id description: The ID of the benefit. created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. type: type: string const: downloadables title: Type description: type: string title: Description description: The description of the benefit. selectable: type: boolean title: Selectable description: Whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' properties: $ref: '#/components/schemas/BenefitDownloadablesProperties' type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - properties title: BenefitDownloadables BenefitLicenseKeys: properties: id: type: string format: uuid4 title: Id description: The ID of the benefit. created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. type: type: string const: license_keys title: Type description: type: string title: Description description: The description of the benefit. selectable: type: boolean title: Selectable description: Whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' properties: $ref: '#/components/schemas/BenefitLicenseKeysProperties' type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - properties title: BenefitLicenseKeys BenefitMeterCredit: properties: id: type: string format: uuid4 title: Id description: The ID of the benefit. created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. type: type: string const: meter_credit title: Type description: type: string title: Description description: The description of the benefit. selectable: type: boolean title: Selectable description: Whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' properties: $ref: '#/components/schemas/BenefitMeterCreditProperties' type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - properties title: BenefitMeterCredit description: |- A benefit of type `meter_unit`. Use it to grant a number of units on a specific meter. BenefitFeatureFlag: properties: id: type: string format: uuid4 title: Id description: The ID of the benefit. created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. type: type: string const: feature_flag title: Type description: type: string title: Description description: The description of the benefit. selectable: type: boolean title: Selectable description: Whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' properties: $ref: '#/components/schemas/BenefitFeatureFlagProperties' type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - properties title: BenefitFeatureFlag description: |- A benefit of type `feature_flag`. Use it to grant feature flags with key-value metadata that can be queried via the API and webhooks. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError BenefitCustomCreateProperties: properties: note: anyOf: - anyOf: - type: string - type: 'null' description: >- Private note to be shared with customers who have this benefit granted. - type: 'null' title: Note type: object title: BenefitCustomCreateProperties description: Properties for creating a benefit of type `custom`. BenefitDiscordCreateProperties: properties: guild_token: type: string title: Guild Token role_id: type: string title: Role Id description: The ID of the Discord role to grant. kick_member: type: boolean title: Kick Member description: Whether to kick the member from the Discord server on revocation. type: object required: - guild_token - role_id - kick_member title: BenefitDiscordCreateProperties description: Properties to create a benefit of type `discord`. BenefitGitHubRepositoryCreateProperties: properties: repository_owner: type: string title: Repository Owner description: The owner of the repository. examples: - polarsource repository_name: type: string title: Repository Name description: The name of the repository. examples: - private_repo permission: type: string enum: - pull - triage - push - maintain - admin title: Permission description: >- The permission level to grant. Read more about roles and their permissions on [GitHub documentation](https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#permissions-for-each-role). type: object required: - repository_owner - repository_name - permission title: BenefitGitHubRepositoryCreateProperties description: Properties to create a benefit of type `github_repository`. BenefitDownloadablesCreateProperties: properties: archived: additionalProperties: type: boolean propertyNames: format: uuid4 type: object title: Archived default: {} files: items: type: string format: uuid4 type: array minItems: 1 title: Files type: object required: - files title: BenefitDownloadablesCreateProperties BenefitLicenseKeysCreateProperties: properties: prefix: anyOf: - type: string - type: 'null' title: Prefix expires: anyOf: - $ref: '#/components/schemas/BenefitLicenseKeyExpirationProperties' - type: 'null' activations: anyOf: - $ref: '#/components/schemas/BenefitLicenseKeyActivationCreateProperties' - type: 'null' limit_usage: anyOf: - type: integer exclusiveMinimum: 0 - type: 'null' title: Limit Usage type: object title: BenefitLicenseKeysCreateProperties BenefitMeterCreditCreateProperties: properties: units: type: integer maximum: 2147483647 exclusiveMinimum: 0 title: Units rollover: type: boolean title: Rollover meter_id: type: string format: uuid4 title: Meter Id type: object required: - units - rollover - meter_id title: BenefitMeterCreditCreateProperties description: Properties for creating a benefit of type `meter_unit`. BenefitFeatureFlagCreateProperties: properties: {} type: object title: BenefitFeatureFlagCreateProperties description: Properties for creating a benefit of type `feature_flag`. MetadataOutputType: additionalProperties: anyOf: - type: string - type: integer - type: number - type: boolean type: object BenefitCustomProperties: properties: note: anyOf: - anyOf: - type: string - type: 'null' description: >- Private note to be shared with customers who have this benefit granted. - type: 'null' title: Note type: object required: - note title: BenefitCustomProperties description: Properties for a benefit of type `custom`. BenefitDiscordProperties: properties: guild_id: type: string title: Guild Id description: The ID of the Discord server. role_id: type: string title: Role Id description: The ID of the Discord role to grant. kick_member: type: boolean title: Kick Member description: Whether to kick the member from the Discord server on revocation. guild_token: type: string title: Guild Token type: object required: - guild_id - role_id - kick_member - guild_token title: BenefitDiscordProperties description: Properties for a benefit of type `discord`. BenefitGitHubRepositoryProperties: properties: repository_owner: type: string title: Repository Owner description: The owner of the repository. examples: - polarsource repository_name: type: string title: Repository Name description: The name of the repository. examples: - private_repo permission: type: string enum: - pull - triage - push - maintain - admin title: Permission description: >- The permission level to grant. Read more about roles and their permissions on [GitHub documentation](https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#permissions-for-each-role). type: object required: - repository_owner - repository_name - permission title: BenefitGitHubRepositoryProperties description: Properties for a benefit of type `github_repository`. BenefitDownloadablesProperties: properties: archived: additionalProperties: type: boolean propertyNames: format: uuid4 type: object title: Archived files: items: type: string format: uuid4 type: array title: Files type: object required: - archived - files title: BenefitDownloadablesProperties BenefitLicenseKeysProperties: properties: prefix: anyOf: - type: string - type: 'null' title: Prefix expires: anyOf: - $ref: '#/components/schemas/BenefitLicenseKeyExpirationProperties' - type: 'null' activations: anyOf: - $ref: '#/components/schemas/BenefitLicenseKeyActivationProperties' - type: 'null' limit_usage: anyOf: - type: integer - type: 'null' title: Limit Usage type: object required: - prefix - expires - activations - limit_usage title: BenefitLicenseKeysProperties BenefitMeterCreditProperties: properties: units: type: integer title: Units rollover: type: boolean title: Rollover meter_id: type: string format: uuid4 title: Meter Id type: object required: - units - rollover - meter_id title: BenefitMeterCreditProperties description: Properties for a benefit of type `meter_unit`. BenefitFeatureFlagProperties: properties: {} type: object title: BenefitFeatureFlagProperties description: Properties for a benefit of type `feature_flag`. BenefitLicenseKeyExpirationProperties: properties: ttl: type: integer exclusiveMinimum: 0 title: Ttl timeframe: type: string enum: - year - month - day title: Timeframe type: object required: - ttl - timeframe title: BenefitLicenseKeyExpirationProperties BenefitLicenseKeyActivationCreateProperties: properties: limit: type: integer maximum: 50 exclusiveMinimum: 0 title: Limit enable_customer_admin: type: boolean title: Enable Customer Admin type: object required: - limit - enable_customer_admin title: BenefitLicenseKeyActivationCreateProperties BenefitLicenseKeyActivationProperties: properties: limit: type: integer title: Limit enable_customer_admin: type: boolean title: Enable Customer Admin type: object required: - limit - enable_customer_admin title: BenefitLicenseKeyActivationProperties securitySchemes: access_token: type: http scheme: bearer description: >- You can generate an **Organization Access Token** from your organization's settings. ````