> ## 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. # List Benefit Grants > List the individual grants for a benefit. It's especially useful to check if a user has been granted a benefit. **Scopes**: `benefits:read` `benefits:write` ## OpenAPI ````yaml get /v1/benefits/{id}/grants 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/{id}/grants: get: tags: - benefits - public summary: List Benefit Grants description: |- List the individual grants for a benefit. It's especially useful to check if a user has been granted a benefit. **Scopes**: `benefits:read` `benefits:write` operationId: benefits:grants parameters: - name: id in: path required: true schema: type: string format: uuid4 description: The benefit ID. x-polar-selector-widget: resourceRoot: /v1/benefits resourceName: Benefit displayProperty: description title: Id - name: is_granted in: query required: false schema: anyOf: - type: boolean - type: 'null' description: >- Filter by granted status. If `true`, only granted benefits will be returned. If `false`, only revoked benefits will be returned. title: Is Granted description: >- Filter by granted status. If `true`, only granted benefits will be returned. If `false`, only revoked benefits will be returned. - name: customer_id in: query required: false schema: anyOf: - type: string format: uuid4 description: The customer ID. - type: array items: type: string format: uuid4 description: The customer ID. - type: 'null' title: CustomerID Filter description: Filter by customer. description: Filter by customer. - name: member_id in: query required: false schema: anyOf: - type: string format: uuid4 - items: type: string format: uuid4 type: array - type: 'null' title: MemberID Filter description: Filter by member. description: Filter by member. - name: page in: query required: false schema: type: integer exclusiveMinimum: 0 description: Page number, defaults to 1. default: 1 title: Page description: Page number, defaults to 1. - name: limit in: query required: false schema: type: integer exclusiveMinimum: 0 description: Size of a page, defaults to 10. Maximum is 100. default: 10 title: Limit description: Size of a page, defaults to 10. Maximum is 100. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListResource_BenefitGrant_' '404': description: Benefit not found. content: application/json: schema: $ref: '#/components/schemas/ResourceNotFound' '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/operations\"\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.Grants(ctx, operations.BenefitsGrantsRequest{\n ID: \"\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.ListResourceBenefitGrant != nil {\n for {\n // handle items\n\n res, err = res.Next()\n\n if err != nil {\n // handle error\n }\n\n if res == nil {\n break\n }\n }\n }\n}" - lang: python label: Python (SDK) source: |- from polar_sdk import Polar with Polar( access_token="", ) as polar: res = polar.benefits.grants(id="", page=1, limit=10) while res is not None: # Handle items res = res.next() - 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.grants({ id: "", }); for await (const page of result) { console.log(page); } } run(); - lang: php label: PHP (SDK) source: |- declare(strict_types=1); require 'vendor/autoload.php'; use Polar; use Polar\Models\Operations; $sdk = Polar\Polar::builder() ->setSecurity( '' ) ->build(); $request = new Operations\BenefitsGrantsRequest( id: '', ); $responses = $sdk->benefits->grants( request: $request ); foreach ($responses as $response) { if ($response->statusCode === 200) { // handle response } } components: schemas: ListResource_BenefitGrant_: properties: items: items: $ref: '#/components/schemas/BenefitGrant' type: array title: Items pagination: $ref: '#/components/schemas/Pagination' type: object required: - items - pagination title: ListResource[BenefitGrant] ResourceNotFound: properties: error: type: string const: ResourceNotFound title: Error examples: - ResourceNotFound detail: type: string title: Detail type: object required: - error - detail title: ResourceNotFound HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError BenefitGrant: properties: 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. id: type: string format: uuid4 title: Id description: The ID of the grant. granted_at: anyOf: - type: string format: date-time - type: 'null' title: Granted At description: >- The timestamp when the benefit was granted. If `None`, the benefit is not granted. is_granted: type: boolean title: Is Granted description: Whether the benefit is granted. revoked_at: anyOf: - type: string format: date-time - type: 'null' title: Revoked At description: >- The timestamp when the benefit was revoked. If `None`, the benefit is not revoked. is_revoked: type: boolean title: Is Revoked description: Whether the benefit is revoked. subscription_id: anyOf: - type: string format: uuid4 - type: 'null' title: Subscription Id description: The ID of the subscription that granted this benefit. order_id: anyOf: - type: string format: uuid4 - type: 'null' title: Order Id description: The ID of the order that granted this benefit. customer_id: type: string format: uuid4 title: Customer Id description: The ID of the customer concerned by this grant. member_id: anyOf: - type: string format: uuid4 - type: 'null' title: Member Id description: The ID of the member concerned by this grant. benefit_id: type: string format: uuid4 title: Benefit Id description: The ID of the benefit concerned by this grant. error: anyOf: - $ref: '#/components/schemas/BenefitGrantError' - type: 'null' description: >- The error information if the benefit grant failed with an unrecoverable error. customer: $ref: '#/components/schemas/Customer' member: anyOf: - $ref: '#/components/schemas/Member' - type: 'null' benefit: $ref: '#/components/schemas/Benefit' title: Benefit properties: anyOf: - $ref: '#/components/schemas/BenefitGrantDiscordProperties' - $ref: '#/components/schemas/BenefitGrantGitHubRepositoryProperties' - $ref: '#/components/schemas/BenefitGrantDownloadablesProperties' - $ref: '#/components/schemas/BenefitGrantLicenseKeysProperties' - $ref: '#/components/schemas/BenefitGrantCustomProperties' - $ref: '#/components/schemas/BenefitGrantFeatureFlagProperties' title: Properties type: object required: - created_at - modified_at - id - is_granted - is_revoked - subscription_id - order_id - customer_id - benefit_id - customer - benefit - properties title: BenefitGrant Pagination: properties: total_count: type: integer title: Total Count max_page: type: integer title: Max Page type: object required: - total_count - max_page title: Pagination 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 BenefitGrantError: properties: message: type: string title: Message type: type: string title: Type timestamp: type: string title: Timestamp type: object required: - message - type - timestamp title: BenefitGrantError Customer: oneOf: - $ref: '#/components/schemas/CustomerIndividual' - $ref: '#/components/schemas/CustomerTeam' discriminator: propertyName: type mapping: individual: $ref: '#/components/schemas/CustomerIndividual' team: $ref: '#/components/schemas/CustomerTeam' Member: properties: id: type: string format: uuid4 title: Id description: The ID of the member. 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. customer_id: type: string format: uuid4 title: Customer Id description: The ID of the customer this member belongs to. email: type: string title: Email description: The email address of the member. examples: - member@example.com name: anyOf: - type: string - type: 'null' title: Name description: The name of the member. examples: - Jane Doe external_id: anyOf: - type: string - type: 'null' title: External Id description: >- The ID of the member in your system. This must be unique within the customer. examples: - usr_1337 role: $ref: '#/components/schemas/MemberRole' description: The role of the member within the customer. examples: - owner type: object required: - id - created_at - modified_at - customer_id - email - name - external_id - role title: Member description: A member of a customer. 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' BenefitGrantDiscordProperties: properties: account_id: anyOf: - type: string - type: 'null' title: Account Id guild_id: type: string title: Guild Id role_id: type: string title: Role Id granted_account_id: type: string title: Granted Account Id type: object title: BenefitGrantDiscordProperties BenefitGrantGitHubRepositoryProperties: properties: account_id: anyOf: - type: string - type: 'null' title: Account Id repository_owner: type: string title: Repository Owner repository_name: type: string title: Repository Name permission: type: string enum: - pull - triage - push - maintain - admin title: Permission granted_account_id: type: string title: Granted Account Id type: object title: BenefitGrantGitHubRepositoryProperties BenefitGrantDownloadablesProperties: properties: files: items: type: string type: array title: Files type: object title: BenefitGrantDownloadablesProperties BenefitGrantLicenseKeysProperties: properties: user_provided_key: type: string title: User Provided Key license_key_id: type: string title: License Key Id display_key: type: string title: Display Key type: object title: BenefitGrantLicenseKeysProperties BenefitGrantCustomProperties: properties: {} type: object title: BenefitGrantCustomProperties BenefitGrantFeatureFlagProperties: properties: {} type: object title: BenefitGrantFeatureFlagProperties CustomerIndividual: properties: id: type: string format: uuid4 title: Id description: The ID of the customer. examples: - 992fae2a-2a17-4b7a-8d9e-e287cf90131b 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. metadata: $ref: '#/components/schemas/MetadataOutputType' external_id: anyOf: - type: string - type: 'null' title: External Id description: >- The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated. examples: - usr_1337 email: type: string title: Email description: >- The email address of the customer. This must be unique within the organization. examples: - customer@example.com email_verified: type: boolean title: Email Verified description: >- Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address. examples: - true type: type: string const: individual title: Type description: The type of customer. examples: - individual name: anyOf: - type: string - type: 'null' title: Name description: The name of the customer. examples: - John Doe billing_address: anyOf: - $ref: '#/components/schemas/Address' - type: 'null' tax_id: anyOf: - prefixItems: - type: string - $ref: '#/components/schemas/TaxIDFormat' type: array maxItems: 2 minItems: 2 examples: - - '911144442' - us_ein - - FR61954506077 - eu_vat - type: 'null' title: Tax Id locale: anyOf: - type: string - type: 'null' title: Locale organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the customer. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 deleted_at: anyOf: - type: string format: date-time - type: 'null' title: Deleted At description: Timestamp for when the customer was soft deleted. avatar_url: type: string title: Avatar Url examples: - https://www.gravatar.com/avatar/xxx?d=404 type: object required: - id - created_at - modified_at - metadata - email - email_verified - type - name - billing_address - tax_id - organization_id - deleted_at - avatar_url title: CustomerIndividual description: A customer in an organization. CustomerTeam: properties: id: type: string format: uuid4 title: Id description: The ID of the customer. examples: - 992fae2a-2a17-4b7a-8d9e-e287cf90131b 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. metadata: $ref: '#/components/schemas/MetadataOutputType' external_id: anyOf: - type: string - type: 'null' title: External Id description: >- The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated. examples: - usr_1337 email: anyOf: - type: string - type: 'null' title: Email description: >- The email address of the customer. This must be unique within the organization. examples: - customer@example.com email_verified: type: boolean title: Email Verified description: >- Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address. examples: - true type: type: string const: team title: Type description: The type of customer. Team customers can have multiple members. examples: - team name: anyOf: - type: string - type: 'null' title: Name description: The name of the customer. examples: - John Doe billing_address: anyOf: - $ref: '#/components/schemas/Address' - type: 'null' tax_id: anyOf: - prefixItems: - type: string - $ref: '#/components/schemas/TaxIDFormat' type: array maxItems: 2 minItems: 2 examples: - - '911144442' - us_ein - - FR61954506077 - eu_vat - type: 'null' title: Tax Id locale: anyOf: - type: string - type: 'null' title: Locale organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the customer. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 deleted_at: anyOf: - type: string format: date-time - type: 'null' title: Deleted At description: Timestamp for when the customer was soft deleted. avatar_url: type: string title: Avatar Url examples: - https://www.gravatar.com/avatar/xxx?d=404 type: object required: - id - created_at - modified_at - metadata - email_verified - type - name - billing_address - tax_id - organization_id - deleted_at - avatar_url title: CustomerTeam description: A team customer in an organization. MemberRole: type: string enum: - owner - billing_manager - member title: MemberRole 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. MetadataOutputType: additionalProperties: anyOf: - type: string - type: integer - type: number - type: boolean type: object Address: properties: line1: anyOf: - type: string - type: 'null' title: Line1 line2: anyOf: - type: string - type: 'null' title: Line2 postal_code: anyOf: - type: string - type: 'null' title: Postal Code city: anyOf: - type: string - type: 'null' title: City state: anyOf: - type: string - type: 'null' title: State country: type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW title: CountryAlpha2 examples: - US - SE - FR x-speakeasy-enums: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW type: object required: - country title: Address 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 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. ````