Delete Benefit

Delete a benefit.

[!WARNING] Every grants associated with the benefit will be revoked. Users will lose access to the benefit.

Scopes: benefits:write

DELETE /v1/benefits/{id}

Go (SDK)

Go

package main

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

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

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

    res, err := s.Benefits.Delete(ctx, "<value>")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

403

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

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string<uuid4> · required

The benefit ID.

Response

204

Benefit deleted.