Get Order

GET

customer-portal

orders

{id}

package main

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

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

    s := polargo.New()

    res, err := s.CustomerPortal.Orders.Get(ctx, operations.CustomerPortalOrdersGetSecurity{
        CustomerSession: os.Getenv("POLAR_CUSTOMER_SESSION"),
    }, "<value>")
    if err != nil {
        log.Fatal(err)
    }
    if res.CustomerOrder != nil {
        // handle response
    }
}

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<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>",
  "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": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
      "name": "<string>",
      "slug": "<string>",
      "avatar_url": "<string>",
      "email": "<string>",
      "website": "<string>",
      "socials": [
        {
          "platform": "x",
          "url": "<string>"
        }
      ],
      "details_submitted_at": "2023-11-07T05:31:56Z",
      "feature_settings": {
        "issue_funding_enabled": false
      },
      "subscription_settings": {
        "allow_multiple_subscriptions": true,
        "allow_customer_updates": true,
        "proration_behavior": "invoice"
      },
      "bio": "<string>",
      "company": "<string>",
      "blog": "<string>",
      "location": "<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>"
      }
    }
  },
  "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>",
    "discount_id": "<string>",
    "checkout_id": "<string>",
    "customer_cancellation_reason": "customer_service",
    "customer_cancellation_comment": "<string>",
    "price_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>"
    }
  ]
}

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.

Path Parameters

string

required

The order ID.

Response

200

application/json

Successful Response

created_at

string

required

Creation timestamp of the object.

modified_at

string | null

required

Last modification timestamp of the object.

string

required

subtotal_amount

integer

required

Amount in cents, before discounts and taxes.

discount_amount

integer

required

Discount amount in cents.

net_amount

integer

required

Amount in cents, after discounts but before taxes.

amount

integer

requireddeprecated

Amount in cents, after discounts but before taxes.

tax_amount

integer

required

Sales tax amount in cents.

total_amount

integer

required

Amount in cents, after discounts and taxes.

refunded_amount

integer

required

Amount refunded in cents.

refunded_tax_amount

integer

required

Sales tax refunded in cents.

currency

string

required

customer_id

string

required

product_id

string

required

product_price_id

string

requireddeprecated

subscription_id

string | null

required

user_id

string

requireddeprecated

product

object

required

product.created_at

string

required

Creation timestamp of the object.

product.modified_at

string | null

required

Last modification timestamp of the object.

product.id

string

required

The ID of the product.

product.name

string

required

The name of the product.

product.description

string | null

required

The description of the product.

product.recurring_interval

enum<string> | null

required

The recurring interval of the product. If None, the product is a one-time purchase.

Available options:

month,

year

product.is_recurring

boolean

required

Whether the product is a subscription.

product.is_archived

boolean

required

Whether the product is archived and no longer available.

product.organization_id

string

required

The ID of the organization owning the product.

product.prices

object[]

required

List of prices for this product.

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

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

product.benefits

object[]

required

List of benefits granted by the product.

product.medias

object[]

required

List of medias associated to the product.

File to be used as a product media file.

product.organization

object

required

product.organization.created_at

string

required

Creation timestamp of the object.

product.organization.modified_at

string | null

required

Last modification timestamp of the object.

product.organization.id

string

required

The organization ID.

Example:

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

product.organization.name

string

required

Organization name shown in checkout, customer portal, emails etc.

product.organization.slug

string

required

Unique organization slug in checkout, customer portal and credit card statements.

product.organization.avatar_url

string | null

required

Avatar URL shown in checkout, customer portal, emails etc.

product.organization.email

string | null

required

Public support email.

product.organization.website

string | null

required

Official website of the organization.

product.organization.socials

object[]

required

Links to social profiles.

product.organization.details_submitted_at

string | null

required

When the business details were submitted.

product.organization.feature_settings

object | null

required

Organization feature settings

product.organization.subscription_settings

object

required

Settings related to subscriptions management

product.organization.bio

string | null

requireddeprecated

product.organization.company

string | null

requireddeprecated

product.organization.blog

string | null

requireddeprecated

product.organization.location

string | null

requireddeprecated

product.organization.twitter_username

string | null

requireddeprecated

product.organization.pledge_minimum_amount

integer

requireddeprecated

product.organization.pledge_badge_show_amount

boolean

requireddeprecated

product.organization.default_upfront_split_to_contributors

integer | null

requireddeprecated

product.organization.profile_settings

object | null

requireddeprecated

Settings for the organization profile

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.

subscription

object | null

required

subscription.created_at

string

required

Creation timestamp of the object.

subscription.modified_at

string | null

required

Last modification timestamp of the object.

subscription.id

string

required

The ID of the object.

subscription.amount

integer

required

The amount of the subscription.

subscription.currency

string

required

The currency of the subscription.

subscription.recurring_interval

enum<string>

required

The interval at which the subscription recurs.

Available options:

month,

year

subscription.status

enum<string>

required

The status of the subscription.

Available options:

incomplete,

incomplete_expired,

trialing,

active,

past_due,

canceled,

unpaid

subscription.current_period_start

string

required

The start timestamp of the current billing period.

subscription.current_period_end

string | null

required

The end timestamp of the current billing period.

subscription.cancel_at_period_end

boolean

required

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

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.

subscription.started_at

string | null

required

The timestamp when the subscription started.

subscription.ends_at

string | null

required

The timestamp when the subscription will end.

subscription.ended_at

string | null

required

The timestamp when the subscription ended.

subscription.customer_id

string

required

The ID of the subscribed customer.

subscription.product_id

string

required

The ID of the subscribed product.

subscription.discount_id

string | null

required

The ID of the applied discount, if any.

subscription.checkout_id

string | null

required

subscription.customer_cancellation_reason

enum<string> | null

required

Available options:

customer_service,

low_quality,

missing_features,

switched_service,

too_complex,

too_expensive,

unused,

other

subscription.customer_cancellation_comment

string | null

required

subscription.price_id

string

requireddeprecated

items

object[]

required

Line items composing the order.

An order line item.

Was this page helpful?

Cancel Subscription

List Orders

package main

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

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

    s := polargo.New()

    res, err := s.CustomerPortal.Orders.Get(ctx, operations.CustomerPortalOrdersGetSecurity{
        CustomerSession: os.Getenv("POLAR_CUSTOMER_SESSION"),
    }, "<value>")
    if err != nil {
        log.Fatal(err)
    }
    if res.CustomerOrder != nil {
        // handle response
    }
}

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<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>",
  "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": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
      "name": "<string>",
      "slug": "<string>",
      "avatar_url": "<string>",
      "email": "<string>",
      "website": "<string>",
      "socials": [
        {
          "platform": "x",
          "url": "<string>"
        }
      ],
      "details_submitted_at": "2023-11-07T05:31:56Z",
      "feature_settings": {
        "issue_funding_enabled": false
      },
      "subscription_settings": {
        "allow_multiple_subscriptions": true,
        "allow_customer_updates": true,
        "proration_behavior": "invoice"
      },
      "bio": "<string>",
      "company": "<string>",
      "blog": "<string>",
      "location": "<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>"
      }
    }
  },
  "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>",
    "discount_id": "<string>",
    "checkout_id": "<string>",
    "customer_cancellation_reason": "customer_service",
    "customer_cancellation_comment": "<string>",
    "price_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>"
    }
  ]
}

Core API

Customer Portal API

Webhook Events

OAuth 2.0 API

Authorizations

Path Parameters

Response