List Discounts

GET

discounts

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.Discounts.List(ctx, operations.DiscountsListRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceDiscount != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

{
  "items": [
    {
      "duration": "once",
      "type": "fixed",
      "amount": 123,
      "currency": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "metadata": {},
      "name": "<string>",
      "code": "<string>",
      "starts_at": "2023-11-07T05:31:56Z",
      "ends_at": "2023-11-07T05:31:56Z",
      "max_redemptions": 123,
      "redemptions_count": 123,
      "organization_id": "<string>",
      "products": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "recurring_interval": "month",
          "is_recurring": true,
          "is_archived": true,
          "organization_id": "<string>"
        }
      ]
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

organization_id

Filter by organization ID.

query

string | null

Filter by name.

page

integer

default:

Page number, defaults to 1.

Required range: x > 0

limit

integer

default:

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

Required range: x > 0

sorting

enum<string>[] | null

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Available options:

created_at,

-created_at,

name,

-name,

code,

-code,

redemptions_count,

-redemptions_count

Response

200

application/json

Successful Response

items

object[]

required

items.duration

enum<string>

required

Available options:

once,

forever,

repeating

items.type

enum<string>

required

Available options:

fixed,

percentage

items.amount

integer

required

items.currency

string

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 object.

items.metadata

object

required

items.name

string

required

Name of the discount. Will be displayed to the customer when the discount is applied.

items.code

string | null

required

Code customers can use to apply the discount during checkout.

items.starts_at

string | null

required

Timestamp after which the discount is redeemable.

items.ends_at

string | null

required

Timestamp after which the discount is no longer redeemable.

items.max_redemptions

integer | null

required

Maximum number of times the discount can be redeemed.

items.redemptions_count

integer

required

Number of times the discount has been redeemed.

items.organization_id

string

required

The organization ID.

items.products

object[]

required

pagination

object

required

Was this page helpful?

Get Discount

Create Discount

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.Discounts.List(ctx, operations.DiscountsListRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceDiscount != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

{
  "items": [
    {
      "duration": "once",
      "type": "fixed",
      "amount": 123,
      "currency": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "metadata": {},
      "name": "<string>",
      "code": "<string>",
      "starts_at": "2023-11-07T05:31:56Z",
      "ends_at": "2023-11-07T05:31:56Z",
      "max_redemptions": 123,
      "redemptions_count": 123,
      "organization_id": "<string>",
      "products": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "recurring_interval": "month",
          "is_recurring": true,
          "is_archived": true,
          "organization_id": "<string>"
        }
      ]
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Core API

Customer Portal API

Webhook Events

OAuth 2.0 API

List Discounts

Authorizations

Query Parameters

Response