List Benefit Grants

GET

benefits

{id}

grants

package main

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

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

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

    res, err := s.Benefits.Grants(ctx, operations.BenefitsGrantsRequest{
        ID: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceBenefitGrant != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "granted_at": "2023-11-07T05:31:56Z",
      "is_granted": true,
      "revoked_at": "2023-11-07T05:31:56Z",
      "is_revoked": true,
      "subscription_id": "<string>",
      "order_id": "<string>",
      "customer_id": "<string>",
      "user_id": "<string>",
      "benefit_id": "<string>",
      "customer": {
        "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "metadata": {},
        "external_id": "usr_1337",
        "email": "customer@example.com",
        "email_verified": true,
        "name": "John Doe",
        "billing_address": {
          "line1": "<string>",
          "line2": "<string>",
          "postal_code": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "US"
        },
        "tax_id": [
          "911144442",
          "us_ein"
        ],
        "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
        "deleted_at": "2023-11-07T05:31:56Z",
        "avatar_url": "https://www.gravatar.com/avatar/xxx?d=blank"
      },
      "properties": {
        "account_id": "<string>",
        "guild_id": "<string>",
        "role_id": "<string>"
      }
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

The benefit ID.

Query Parameters

is_granted

boolean | null

Filter by granted status. If true, only granted benefits will be returned. If false, only revoked benefits will be returned.

customer_id

Filter by customer.

page

integer

default:1

Page number, defaults to 1.

Required range: x > 0

limit

integer

default:10

Size of a page, defaults to 10. Maximum is 100.

Required range: x > 0

Response

200

application/json

Successful Response

items

object[]

required

items.created_at

string

required

Creation timestamp of the object.

items.modified_at

string | null

required

Last modification timestamp of the object.

items.id

string

required

The ID of the grant.

items.is_granted

boolean

required

Whether the benefit is granted.

items.is_revoked

boolean

required

Whether the benefit is revoked.

items.subscription_id

string | null

required

The ID of the subscription that granted this benefit.

items.order_id

string | null

required

The ID of the order that granted this benefit.

items.customer_id

string

required

The ID of the customer concerned by this grant.

items.user_id

string

required

deprecated

items.benefit_id

string

required

The ID of the benefit concerned by this grant.

items.customer

object

required

A customer in an organization.

items.customer.id

string

required

The ID of the customer.

Example:

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

items.customer.created_at

string

required

Creation timestamp of the object.

items.customer.modified_at

string | null

required

Last modification timestamp of the object.

items.customer.metadata

object

required

items.customer.external_id

string | null

required

The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.

Example:

"usr_1337"

items.customer.email

string

required

The email address of the customer. This must be unique within the organization.

Example:

"customer@example.com"

items.customer.email_verified

boolean

required

Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.

Example:

true

items.customer.name

string | null

required

The name of the customer.

Example:

"John Doe"

items.customer.billing_address

object | null

required

items.customer.tax_id

any[] | null

required

Example:

["911144442", "us_ein"]

items.customer.organization_id

string

required

The ID of the organization owning the customer.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

items.customer.deleted_at

string | null

required

Timestamp for when the customer was soft deleted.

items.customer.avatar_url

string

required

Example:

"https://www.gravatar.com/avatar/xxx?d=blank"

items.properties

object

required

items.granted_at

string | null

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

items.revoked_at

string | null

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

pagination

object

required

Was this page helpful?

List Benefits

Update Benefit

package main

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

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

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

    res, err := s.Benefits.Grants(ctx, operations.BenefitsGrantsRequest{
        ID: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceBenefitGrant != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "granted_at": "2023-11-07T05:31:56Z",
      "is_granted": true,
      "revoked_at": "2023-11-07T05:31:56Z",
      "is_revoked": true,
      "subscription_id": "<string>",
      "order_id": "<string>",
      "customer_id": "<string>",
      "user_id": "<string>",
      "benefit_id": "<string>",
      "customer": {
        "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "metadata": {},
        "external_id": "usr_1337",
        "email": "customer@example.com",
        "email_verified": true,
        "name": "John Doe",
        "billing_address": {
          "line1": "<string>",
          "line2": "<string>",
          "postal_code": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "US"
        },
        "tax_id": [
          "911144442",
          "us_ein"
        ],
        "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
        "deleted_at": "2023-11-07T05:31:56Z",
        "avatar_url": "https://www.gravatar.com/avatar/xxx?d=blank"
      },
      "properties": {
        "account_id": "<string>",
        "guild_id": "<string>",
        "role_id": "<string>"
      }
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Core API

Customer Portal API

Webhook Events

OAuth 2.0 API

List Benefit Grants

Authorizations

Path Parameters

Query Parameters

Response