GET
/
v1
/
customer-portal
/
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.CustomerPortal.Orders.List(ctx, operations.CustomerPortalOrdersListRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceCustomerOrder != 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>",
      "amount": 123,
      "tax_amount": 123,
      "currency": "<string>",
      "customer_id": "<string>",
      "product_id": "<string>",
      "product_price_id": "<string>",
      "subscription_id": "<string>",
      "user_id": "<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>",
        "prices": [
          {
            "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
          }
        ],
        "benefits": [
          {
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z",
            "id": "<string>",
            "type": "custom",
            "description": "<string>",
            "selectable": true,
            "deletable": true,
            "organization_id": "<string>"
          }
        ],
        "medias": [
          {
            "id": "<string>",
            "organization_id": "<string>",
            "name": "<string>",
            "path": "<string>",
            "mime_type": "<string>",
            "size": 123,
            "storage_version": "<string>",
            "checksum_etag": "<string>",
            "checksum_sha256_base64": "<string>",
            "checksum_sha256_hex": "<string>",
            "last_modified_at": "2023-11-07T05:31:56Z",
            "version": "<string>",
            "service": "<string>",
            "is_uploaded": true,
            "created_at": "2023-11-07T05:31:56Z",
            "size_readable": "<string>",
            "public_url": "<string>"
          }
        ],
        "organization": {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "name": "<string>",
          "slug": "<string>",
          "avatar_url": "<string>",
          "bio": "<string>",
          "company": "<string>",
          "blog": "<string>",
          "location": "<string>",
          "email": "<string>",
          "twitter_username": "<string>",
          "pledge_minimum_amount": 123,
          "pledge_badge_show_amount": true,
          "default_upfront_split_to_contributors": 123,
          "profile_settings": {
            "enabled": true,
            "description": "<string>",
            "featured_projects": [
              "<string>"
            ],
            "featured_organizations": [
              "<string>"
            ],
            "links": [
              "<string>"
            ],
            "subscribe": {
              "promote": true,
              "show_count": true,
              "count_free": true
            },
            "accent_color": "<string>"
          },
          "feature_settings": {
            "issue_funding_enabled": false
          },
          "subscription_settings": {
            "allow_multiple_subscriptions": true,
            "allow_customer_updates": true,
            "proration_behavior": "invoice"
          }
        }
      },
      "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
      },
      "subscription": {
        "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>",
        "price_id": "<string>",
        "discount_id": "<string>",
        "checkout_id": "<string>",
        "customer_cancellation_reason": "customer_service",
        "customer_cancellation_comment": "<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.

​
product_id

Filter by product ID.

​
product_price_type

Filter by product price type. recurring will return orders corresponding to subscriptions creations or renewals. one_time will return orders corresponding to one-time purchases.

Available options:
one_time,
recurring
​
subscription_id

Filter by subscription ID.

​
query
string | null

Search by product or organization name.

​
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,
organization,
-organization,
product,
-product,
subscription,
-subscription

Response

200
application/json
Successful Response
​
items
object[]
required
​
pagination
object
required

Was this page helpful?

Get Order
Previous
Get Order Invoice
Next