Get Order

GET

customer-portal

orders

{id}

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.customer_portal.orders.get(
    '00000000-0000-4000-8000-000000000000',
)
print(response)

import { createPolar } from "@polar-sh/sdk/2027-01";

const polar = createPolar({
  accessToken: "polar_oat_xxx",
});

const response = await polar.customerPortal.orders.get(
  "00000000-0000-4000-8000-000000000000",
);
console.log(response);

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polar.sh/v1/customer-portal/orders/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.polar.sh/v1/customer-portal/orders/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polar.sh/v1/customer-portal/orders/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/customer-portal/orders/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "created_at": "2026-01-01T00:00:00.000000Z",
  "modified_at": "2026-01-01T00:00:00.000000Z",
  "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": {
    "country": "US",
    "line1": "<string>",
    "line2": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "state": "<string>"
  },
  "invoice_number": "<string>",
  "is_invoice_generated": true,
  "receipt_number": "<string>",
  "units": 123,
  "customer_id": "<string>",
  "product_id": "<string>",
  "discount_id": "<string>",
  "subscription_id": "<string>",
  "checkout_id": "<string>",
  "product": {
    "id": "<string>",
    "created_at": "2026-01-01T00:00:00.000000Z",
    "modified_at": "2026-01-01T00:00:00.000000Z",
    "trial_interval": "day",
    "trial_interval_count": 123,
    "name": "<string>",
    "description": "<string>",
    "visibility": "draft",
    "recurring_interval": "day",
    "recurring_interval_count": 123,
    "meter_interval": "day",
    "meter_interval_count": 123,
    "is_recurring": true,
    "is_archived": true,
    "organization_id": "<string>",
    "prices": [
      {
        "created_at": "2026-01-01T00:00:00.000000Z",
        "modified_at": "2026-01-01T00:00:00.000000Z",
        "id": "<string>",
        "source": "catalog",
        "amount_type": "fixed",
        "price_currency": "<string>",
        "tax_behavior": "location",
        "is_archived": true,
        "product_id": "<string>",
        "price_amount": 123
      }
    ],
    "benefits": [
      {
        "id": "<string>",
        "created_at": "2026-01-01T00:00:00.000000Z",
        "modified_at": "2026-01-01T00:00:00.000000Z",
        "type": "custom",
        "description": "<string>",
        "selectable": true,
        "deletable": true,
        "is_deleted": 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": "2026-01-01T00:00:00.000000Z",
        "version": "<string>",
        "service": "product_media",
        "is_uploaded": true,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "size_readable": "<string>",
        "public_url": "<string>"
      }
    ],
    "organization": {
      "created_at": "2026-01-01T00:00:00.000000Z",
      "modified_at": "2026-01-01T00:00:00.000000Z",
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "avatar_url": "<string>",
      "proration_behavior": "invoice",
      "allow_customer_updates": true,
      "customer_portal_settings": {
        "usage": {
          "show": true
        },
        "subscription": {
          "update_seats": true,
          "update_plan": true,
          "update_units": true,
          "pause": true
        },
        "customer": {
          "allow_email_change": true
        }
      },
      "organization_features": {
        "checkout_localization_enabled": false
      }
    }
  },
  "subscription": {
    "created_at": "2026-01-01T00:00:00.000000Z",
    "modified_at": "2026-01-01T00:00:00.000000Z",
    "id": "<string>",
    "amount": 10000,
    "currency": "usd",
    "recurring_interval": "month",
    "recurring_interval_count": 123,
    "status": "active",
    "current_period_start": "2026-01-01T00:00:00.000000Z",
    "current_period_end": "2026-01-01T00:00:00.000000Z",
    "current_meter_period_start": "2026-01-01T00:00:00.000000Z",
    "current_meter_period_end": "2026-01-01T00:00:00.000000Z",
    "trial_start": "2026-01-01T00:00:00.000000Z",
    "trial_end": "2026-01-01T00:00:00.000000Z",
    "cancel_at_period_end": true,
    "canceled_at": "2026-01-01T00:00:00.000000Z",
    "started_at": "2026-01-01T00:00:00.000000Z",
    "ends_at": "2026-01-01T00:00:00.000000Z",
    "ended_at": "2026-01-01T00:00:00.000000Z",
    "pause_at_period_end": true,
    "paused_at": "2026-01-01T00:00:00.000000Z",
    "resumes_at": "2026-01-01T00:00:00.000000Z",
    "customer_id": "<string>",
    "product_id": "<string>",
    "discount_id": "<string>",
    "checkout_id": "<string>",
    "units": 123,
    "customer_cancellation_reason": "customer_service",
    "customer_cancellation_comment": "<string>",
    "past_due_at": "2026-01-01T00:00:00.000000Z",
    "seats": 123
  },
  "items": [
    {
      "created_at": "2026-01-01T00:00:00.000000Z",
      "modified_at": "2026-01-01T00:00:00.000000Z",
      "id": "<string>",
      "label": "Pro Plan",
      "amount": 10000,
      "tax_amount": 720,
      "proration": false,
      "product_price_id": "<string>",
      "start_timestamp": "2026-01-01T00:00:00.000000Z",
      "end_timestamp": "2026-01-01T00:00:00.000000Z"
    }
  ],
  "description": "Pro Plan",
  "refundable_amount": 9000,
  "refundable_tax_amount": 720,
  "seats": 123,
  "next_payment_attempt_at": "2026-01-01T00:00:00.000000Z"
}

{
  "error": "ResourceNotFound",
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Customer session tokens are specific tokens that are used to authenticate customers on your organization. You can create those sessions programmatically using the Create Customer Session endpoint.

Scopes

customer_portal:read

customer_session

customer_portal:write

customer_session

customer_portal:read

member_session

customer_portal:write

member_session

Path Parameters

string<uuid4>

required

The order ID.

Response

Successful Response

string<uuid4>

required

The ID of the object.

created_at

string<date-time>

required

Creation timestamp of the object.

Example:

"2026-01-01T00:00:00.000000Z"

modified_at

string<date-time> | null

required

Last modification timestamp of the object.

Example:

"2026-01-01T00:00:00.000000Z"

status

enum<string>

required

Available options:

draft,

pending,

paid,

refunded,

partially_refunded,

void

Example:

"paid"

paid

boolean

required

Whether the order has been paid for.

Example:

true

subtotal_amount

integer

required

Amount in cents, before discounts and taxes.

Example:

10000

discount_amount

integer

required

Discount amount in cents.

Example:

1000

net_amount

integer

required

Amount in cents, after discounts but before taxes.

Example:

9000

tax_amount

integer

required

Sales tax amount in cents.

Example:

720

total_amount

integer

required

Amount in cents, after discounts and taxes.

Example:

9720

applied_balance_amount

integer

required

Customer's balance amount applied to this invoice. Can increase the total amount paid, if the customer has a negative balance, or decrease it, if the customer has a positive balance.Amount in cents.

Example:

0

due_amount

integer

required

Amount in cents that is due for this order.

Example:

0

refunded_amount

integer

required

Amount refunded in cents.

Example:

0

refunded_tax_amount

integer

required

Sales tax refunded in cents.

Example:

0

currency

string

required

Example:

"usd"

billing_reason

enum<string>

required

Available options:

purchase,

subscription_create,

subscription_cycle,

subscription_update,

subscription_meter_cycle

billing_name

string | null

required

The name of the customer that should appear on the invoice.

billing_address

Address · object | null

required

Show child attributes

invoice_number

string | null

required

The invoice number associated with this order. null while the order is in draft status; assigned at finalize.

is_invoice_generated

boolean

required

Whether an invoice has been generated for this order.

receipt_number

string | null

required

The receipt number for this order. Set once the order is paid for organizations with receipts enabled. When set, a downloadable receipt PDF can be obtained via the receipt endpoint.

units

integer | null

required

Number of units purchased (for unit-based pricing).

customer_id

string<uuid4>

required

product_id

string<uuid4> | null

required

discount_id

string<uuid4> | null

required

subscription_id

string<uuid4> | null

required

checkout_id

string<uuid4> | null

required

product

CustomerOrderProduct · object | null

required

Show child attributes

subscription

CustomerOrderSubscription · object | null

required

Show child attributes

items

OrderItemSchema · object[]

required

Line items composing the order.

Show child attributes

description

string

required

A summary description of the order.

Example:

"Pro Plan"

refundable_amount

integer

required

read-only

Amount in cents that can still be refunded (net, before taxes). Accounts for any applied customer balance and previous refunds.

Example:

9000

refundable_tax_amount

integer

required

read-only

Sales tax in cents that would be refunded if the full refundable amount is refunded.

Example:

720

seats

integer | null

Number of seats purchased (for seat-based one-time orders).

next_payment_attempt_at

string<date-time> | null

When the next automatic payment retry is scheduled. null if the order is not in dunning or all retries have been exhausted.

Example:

"2026-01-01T00:00:00.000000Z"

⌘I

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.customer_portal.orders.get(
    '00000000-0000-4000-8000-000000000000',
)
print(response)

import { createPolar } from "@polar-sh/sdk/2027-01";

const polar = createPolar({
  accessToken: "polar_oat_xxx",
});

const response = await polar.customerPortal.orders.get(
  "00000000-0000-4000-8000-000000000000",
);
console.log(response);

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polar.sh/v1/customer-portal/orders/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.polar.sh/v1/customer-portal/orders/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polar.sh/v1/customer-portal/orders/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/customer-portal/orders/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "created_at": "2026-01-01T00:00:00.000000Z",
  "modified_at": "2026-01-01T00:00:00.000000Z",
  "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": {
    "country": "US",
    "line1": "<string>",
    "line2": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "state": "<string>"
  },
  "invoice_number": "<string>",
  "is_invoice_generated": true,
  "receipt_number": "<string>",
  "units": 123,
  "customer_id": "<string>",
  "product_id": "<string>",
  "discount_id": "<string>",
  "subscription_id": "<string>",
  "checkout_id": "<string>",
  "product": {
    "id": "<string>",
    "created_at": "2026-01-01T00:00:00.000000Z",
    "modified_at": "2026-01-01T00:00:00.000000Z",
    "trial_interval": "day",
    "trial_interval_count": 123,
    "name": "<string>",
    "description": "<string>",
    "visibility": "draft",
    "recurring_interval": "day",
    "recurring_interval_count": 123,
    "meter_interval": "day",
    "meter_interval_count": 123,
    "is_recurring": true,
    "is_archived": true,
    "organization_id": "<string>",
    "prices": [
      {
        "created_at": "2026-01-01T00:00:00.000000Z",
        "modified_at": "2026-01-01T00:00:00.000000Z",
        "id": "<string>",
        "source": "catalog",
        "amount_type": "fixed",
        "price_currency": "<string>",
        "tax_behavior": "location",
        "is_archived": true,
        "product_id": "<string>",
        "price_amount": 123
      }
    ],
    "benefits": [
      {
        "id": "<string>",
        "created_at": "2026-01-01T00:00:00.000000Z",
        "modified_at": "2026-01-01T00:00:00.000000Z",
        "type": "custom",
        "description": "<string>",
        "selectable": true,
        "deletable": true,
        "is_deleted": 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": "2026-01-01T00:00:00.000000Z",
        "version": "<string>",
        "service": "product_media",
        "is_uploaded": true,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "size_readable": "<string>",
        "public_url": "<string>"
      }
    ],
    "organization": {
      "created_at": "2026-01-01T00:00:00.000000Z",
      "modified_at": "2026-01-01T00:00:00.000000Z",
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "avatar_url": "<string>",
      "proration_behavior": "invoice",
      "allow_customer_updates": true,
      "customer_portal_settings": {
        "usage": {
          "show": true
        },
        "subscription": {
          "update_seats": true,
          "update_plan": true,
          "update_units": true,
          "pause": true
        },
        "customer": {
          "allow_email_change": true
        }
      },
      "organization_features": {
        "checkout_localization_enabled": false
      }
    }
  },
  "subscription": {
    "created_at": "2026-01-01T00:00:00.000000Z",
    "modified_at": "2026-01-01T00:00:00.000000Z",
    "id": "<string>",
    "amount": 10000,
    "currency": "usd",
    "recurring_interval": "month",
    "recurring_interval_count": 123,
    "status": "active",
    "current_period_start": "2026-01-01T00:00:00.000000Z",
    "current_period_end": "2026-01-01T00:00:00.000000Z",
    "current_meter_period_start": "2026-01-01T00:00:00.000000Z",
    "current_meter_period_end": "2026-01-01T00:00:00.000000Z",
    "trial_start": "2026-01-01T00:00:00.000000Z",
    "trial_end": "2026-01-01T00:00:00.000000Z",
    "cancel_at_period_end": true,
    "canceled_at": "2026-01-01T00:00:00.000000Z",
    "started_at": "2026-01-01T00:00:00.000000Z",
    "ends_at": "2026-01-01T00:00:00.000000Z",
    "ended_at": "2026-01-01T00:00:00.000000Z",
    "pause_at_period_end": true,
    "paused_at": "2026-01-01T00:00:00.000000Z",
    "resumes_at": "2026-01-01T00:00:00.000000Z",
    "customer_id": "<string>",
    "product_id": "<string>",
    "discount_id": "<string>",
    "checkout_id": "<string>",
    "units": 123,
    "customer_cancellation_reason": "customer_service",
    "customer_cancellation_comment": "<string>",
    "past_due_at": "2026-01-01T00:00:00.000000Z",
    "seats": 123
  },
  "items": [
    {
      "created_at": "2026-01-01T00:00:00.000000Z",
      "modified_at": "2026-01-01T00:00:00.000000Z",
      "id": "<string>",
      "label": "Pro Plan",
      "amount": 10000,
      "tax_amount": 720,
      "proration": false,
      "product_price_id": "<string>",
      "start_timestamp": "2026-01-01T00:00:00.000000Z",
      "end_timestamp": "2026-01-01T00:00:00.000000Z"
    }
  ],
  "description": "Pro Plan",
  "refundable_amount": 9000,
  "refundable_tax_amount": 720,
  "seats": 123,
  "next_payment_attempt_at": "2026-01-01T00:00:00.000000Z"
}

{
  "error": "ResourceNotFound",
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

General

Core API

Customer Portal API

Webhook Events

Integrations

Authorizations

Scopes

Path Parameters

Response