Skip to main content
GET
/
v1
/
customer-portal
/
orders
/
Go (SDK)
package main

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

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

    s := polargo.New()

    res, err := s.CustomerPortal.Orders.List(ctx, operations.CustomerPortalOrdersListRequest{}, operations.CustomerPortalOrdersListSecurity{
        CustomerSession: os.Getenv("POLAR_CUSTOMER_SESSION"),
    })
    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": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "status": "paid",
      "paid": true,
      "subtotal_amount": 10000,
      "discount_amount": 1000,
      "net_amount": 9000,
      "tax_amount": 720,
      "total_amount": 9720,
      "applied_balance_amount": 0,
      "due_amount": 0,
      "refunded_amount": 0,
      "refunded_tax_amount": 0,
      "currency": "usd",
      "billing_reason": "purchase",
      "billing_name": "<string>",
      "billing_address": {
        "line1": "<string>",
        "line2": "<string>",
        "postal_code": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "US"
      },
      "invoice_number": "<string>",
      "is_invoice_generated": true,
      "seats": 123,
      "customer_id": "<string>",
      "product_id": "<string>",
      "discount_id": "<string>",
      "subscription_id": "<string>",
      "checkout_id": "<string>",
      "user_id": "<string>",
      "product": {
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "trial_interval": "day",
        "trial_interval_count": 123,
        "name": "<string>",
        "description": "<string>",
        "recurring_interval": "day",
        "recurring_interval_count": 123,
        "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>",
            "source": "catalog",
            "amount_type": "<string>",
            "is_archived": true,
            "product_id": "<string>",
            "type": "<string>",
            "recurring_interval": "day",
            "price_currency": "<string>",
            "price_amount": 123,
            "legacy": true
          }
        ],
        "benefits": [
          {
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z",
            "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>",
          "proration_behavior": "invoice",
          "allow_customer_updates": true
        }
      },
      "subscription": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "amount": 10000,
        "currency": "usd",
        "recurring_interval": "month",
        "recurring_interval_count": 123,
        "status": "active",
        "current_period_start": "2023-11-07T05:31:56Z",
        "current_period_end": "2023-11-07T05:31:56Z",
        "trial_start": "2023-11-07T05:31:56Z",
        "trial_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>",
        "seats": 123,
        "customer_cancellation_reason": "customer_service",
        "customer_cancellation_comment": "<string>"
      },
      "items": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "label": "Pro Plan",
          "amount": 10000,
          "tax_amount": 720,
          "proration": false,
          "product_price_id": "<string>"
        }
      ],
      "description": "Pro Plan",
      "next_payment_attempt_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Authorizations

Authorization
string
header
required

Query Parameters

product_id
product_billing_type
Available options:
one_time,
recurring
subscription_id
query
string | null
page
integer
default:1
Required range: x > 0
limit
integer
default:10
Required range: x > 0
sorting
enum<string>[] | null

Response

items
CustomerOrder · object[]
required
pagination
object
required