List Orders

GET

orders

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.Orders.List(ctx, operations.OrdersListRequest{
        OrganizationID: polargo.Pointer(operations.CreateOrdersListQueryParamOrganizationIDFilterArrayOfStr(
            []string{
                "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
            },
        )),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceOrder != 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>",
      "metadata": {},
      "custom_field_data": {},
      "status": "<string>",
      "subtotal_amount": 123,
      "discount_amount": 123,
      "net_amount": 123,
      "amount": 123,
      "tax_amount": 123,
      "total_amount": 123,
      "refunded_amount": 123,
      "refunded_tax_amount": 123,
      "currency": "<string>",
      "billing_reason": "purchase",
      "billing_address": {
        "line1": "<string>",
        "line2": "<string>",
        "postal_code": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "US"
      },
      "customer_id": "<string>",
      "product_id": "<string>",
      "product_price_id": "<string>",
      "discount_id": "<string>",
      "subscription_id": "<string>",
      "checkout_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"
      },
      "user_id": "<string>",
      "user": {
        "id": "<string>",
        "email": "<string>",
        "public_name": "<string>",
        "avatar_url": "<string>",
        "github_username": "<string>"
      },
      "product": {
        "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>"
      },
      "product_price": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "amount_type": "<string>",
        "is_archived": true,
        "product_id": "<string>",
        "type": "<string>",
        "recurring_interval": "month",
        "price_currency": "<string>",
        "price_amount": 123,
        "legacy": true
      },
      "discount": {
        "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": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
      },
      "subscription": {
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "amount": 123,
        "currency": "<string>",
        "recurring_interval": "month",
        "status": "incomplete",
        "current_period_start": "2023-11-07T05:31:56Z",
        "current_period_end": "2023-11-07T05:31:56Z",
        "cancel_at_period_end": true,
        "canceled_at": "2023-11-07T05:31:56Z",
        "started_at": "2023-11-07T05:31:56Z",
        "ends_at": "2023-11-07T05:31:56Z",
        "ended_at": "2023-11-07T05:31:56Z",
        "customer_id": "<string>",
        "product_id": "<string>",
        "discount_id": "<string>",
        "checkout_id": "<string>",
        "customer_cancellation_reason": "customer_service",
        "customer_cancellation_comment": "<string>",
        "price_id": "<string>",
        "user_id": "<string>"
      },
      "items": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "label": "<string>",
          "amount": 123,
          "tax_amount": 123,
          "proration": true,
          "product_price_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.

Query Parameters

organization_id

Filter by organization ID.

Example:

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

product_id

Filter by product ID.

product_billing_type

Filter by product billing type. recurring will filter data corresponding to subscriptions creations or renewals. one_time will filter data corresponding to one-time purchases.

Available options:

one_time,

recurring

product_price_type

deprecated

Available options:

one_time,

recurring

discount_id

Filter by discount ID.

customer_id

Filter by customer ID.

checkout_id

Filter by checkout ID.

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

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,

amount,

-amount,

net_amount,

-net_amount,

customer,

-customer,

product,

-product,

discount,

-discount,

subscription,

-subscription

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

items.metadata

object

required

items.status

string

required

items.subtotal_amount

integer

required

Amount in cents, before discounts and taxes.

items.discount_amount

integer

required

Discount amount in cents.

items.net_amount

integer

required

Amount in cents, after discounts but before taxes.

items.amount

integer

requireddeprecated

Amount in cents, after discounts but before taxes.

items.tax_amount

integer

required

Sales tax amount in cents.

items.total_amount

integer

required

Amount in cents, after discounts and taxes.

items.refunded_amount

integer

required

Amount refunded in cents.

items.refunded_tax_amount

integer

required

Sales tax refunded in cents.

items.currency

string

required

items.billing_reason

enum<string>

required

Available options:

purchase,

subscription_create,

subscription_cycle,

subscription_update

items.billing_address

object | null

required

items.customer_id

string

required

items.product_id

string

required

items.product_price_id

string

requireddeprecated

items.discount_id

string | null

required

items.subscription_id

string | null

required

items.checkout_id

string | null

required

items.customer

object

required

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

string

requireddeprecated

items.user

object

required

items.product

object

required

items.product_price

object

requireddeprecated

A recurring price for a product, i.e. a subscription.

Deprecated: The recurring interval should be set on the product itself.

items.discount

object | null

required

items.subscription

object | null

required

items.subscription.metadata

object

required

items.subscription.created_at

string

required

Creation timestamp of the object.

items.subscription.modified_at

string | null

required

Last modification timestamp of the object.

items.subscription.id

string

required

The ID of the object.

items.subscription.amount

integer

required

The amount of the subscription.

items.subscription.currency

string

required

The currency of the subscription.

items.subscription.recurring_interval

enum<string>

required

The interval at which the subscription recurs.

Available options:

month,

year

items.subscription.status

enum<string>

required

The status of the subscription.

Available options:

incomplete,

incomplete_expired,

trialing,

active,

past_due,

canceled,

unpaid

items.subscription.current_period_start

string

required

The start timestamp of the current billing period.

items.subscription.current_period_end

string | null

required

The end timestamp of the current billing period.

items.subscription.cancel_at_period_end

boolean

required

Whether the subscription will be canceled at the end of the current period.

items.subscription.canceled_at

string | null

required

The timestamp when the subscription was canceled. The subscription might still be active if cancel_at_period_end is true.

items.subscription.started_at

string | null

required

The timestamp when the subscription started.

items.subscription.ends_at

string | null

required

The timestamp when the subscription will end.

items.subscription.ended_at

string | null

required

The timestamp when the subscription ended.

items.subscription.customer_id

string

required

The ID of the subscribed customer.

items.subscription.product_id

string

required

The ID of the subscribed product.

items.subscription.discount_id

string | null

required

The ID of the applied discount, if any.

items.subscription.checkout_id

string | null

required

items.subscription.customer_cancellation_reason

enum<string> | null

required

Available options:

customer_service,

low_quality,

missing_features,

switched_service,

too_complex,

too_expensive,

unused,

other

items.subscription.customer_cancellation_comment

string | null

required

items.subscription.price_id

string

requireddeprecated

items.subscription.user_id

string

requireddeprecated

items.items

object[]

required

Line items composing the order.

An order line item.

items.custom_field_data

object

Key-value object storing custom field values.

pagination

object

required

Was this page helpful?

Get Order

Get Order Invoice

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.Orders.List(ctx, operations.OrdersListRequest{
        OrganizationID: polargo.Pointer(operations.CreateOrdersListQueryParamOrganizationIDFilterArrayOfStr(
            []string{
                "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
            },
        )),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceOrder != 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>",
      "metadata": {},
      "custom_field_data": {},
      "status": "<string>",
      "subtotal_amount": 123,
      "discount_amount": 123,
      "net_amount": 123,
      "amount": 123,
      "tax_amount": 123,
      "total_amount": 123,
      "refunded_amount": 123,
      "refunded_tax_amount": 123,
      "currency": "<string>",
      "billing_reason": "purchase",
      "billing_address": {
        "line1": "<string>",
        "line2": "<string>",
        "postal_code": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "US"
      },
      "customer_id": "<string>",
      "product_id": "<string>",
      "product_price_id": "<string>",
      "discount_id": "<string>",
      "subscription_id": "<string>",
      "checkout_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"
      },
      "user_id": "<string>",
      "user": {
        "id": "<string>",
        "email": "<string>",
        "public_name": "<string>",
        "avatar_url": "<string>",
        "github_username": "<string>"
      },
      "product": {
        "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>"
      },
      "product_price": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "amount_type": "<string>",
        "is_archived": true,
        "product_id": "<string>",
        "type": "<string>",
        "recurring_interval": "month",
        "price_currency": "<string>",
        "price_amount": 123,
        "legacy": true
      },
      "discount": {
        "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": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
      },
      "subscription": {
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "amount": 123,
        "currency": "<string>",
        "recurring_interval": "month",
        "status": "incomplete",
        "current_period_start": "2023-11-07T05:31:56Z",
        "current_period_end": "2023-11-07T05:31:56Z",
        "cancel_at_period_end": true,
        "canceled_at": "2023-11-07T05:31:56Z",
        "started_at": "2023-11-07T05:31:56Z",
        "ends_at": "2023-11-07T05:31:56Z",
        "ended_at": "2023-11-07T05:31:56Z",
        "customer_id": "<string>",
        "product_id": "<string>",
        "discount_id": "<string>",
        "checkout_id": "<string>",
        "customer_cancellation_reason": "customer_service",
        "customer_cancellation_comment": "<string>",
        "price_id": "<string>",
        "user_id": "<string>"
      },
      "items": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "label": "<string>",
          "amount": 123,
          "tax_amount": 123,
          "proration": true,
          "product_price_id": "<string>"
        }
      ]
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Core API

Customer Portal API

Webhook Events

OAuth 2.0 API

Authorizations

Query Parameters

Response