POST
/
v1
/
benefits
package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Benefits.Create(ctx, components.CreateBenefitCreateGithubRepository(
        components.BenefitGitHubRepositoryCreate{
            Description: "yuck forager beneath please shadowy foodstuffs welcome",
            OrganizationID: polargo.String("1dbfc517-0bbf-4301-9ba8-555ca42b9737"),
            Properties: components.BenefitGitHubRepositoryCreateProperties{
                RepositoryOwner: "polarsource",
                RepositoryName: "private_repo",
                Permission: components.BenefitGitHubRepositoryCreatePropertiesPermissionTriage,
            },
        },
    ))
    if err != nil {
        log.Fatal(err)
    }
    if res.Benefit != nil {
        // handle response
    }
}
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "type": "<string>",
  "description": "<string>",
  "selectable": true,
  "deletable": true,
  "organization_id": "<string>",
  "metadata": {},
  "properties": {
    "note": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

You can generate an Organization Access Token from your organization's settings.

Body

application/json

Schema to create a benefit of type custom.

Response

201
application/json
Benefit created.

A benefit of type custom.

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