Skip to main content
PATCH
/
v1
/
customer-portal
/
orders
/
{id}
Go (SDK)
package main

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

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

    s := polargo.New()

    res, err := s.CustomerPortal.Orders.Update(ctx, operations.CustomerPortalOrdersUpdateSecurity{
        CustomerSession: os.Getenv("POLAR_CUSTOMER_SESSION"),
    }, "<value>", components.CustomerOrderUpdate{
        BillingName: polargo.Pointer("<value>"),
        BillingAddress: &components.AddressInput{
            Country: components.CountryAlpha2InputUs,
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.CustomerOrder != nil {
        // handle response
    }
}
{
  "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"
}

Authorizations

Authorization
string
header
required

Path Parameters

id
string<uuid4>
required

Body

application/json
billing_name
string | null
required
billing_address
object | null
required

Response

id
string<uuid4>
required
created_at
string<date-time>
required
modified_at
string<date-time> | null
required
status
enum<string>
required
Available options:
pending,
paid,
refunded,
partially_refunded
paid
boolean
required
Examples:
subtotal_amount
integer
required
Examples:
discount_amount
integer
required
Examples:
net_amount
integer
required
Examples:
tax_amount
integer
required
Examples:
total_amount
integer
required
Examples:
applied_balance_amount
integer
required
Examples:
due_amount
integer
required
Examples:
refunded_amount
integer
required
Examples:
refunded_tax_amount
integer
required
Examples:
currency
string
required
Examples:
billing_reason
enum<string>
required
Available options:
purchase,
subscription_create,
subscription_cycle,
subscription_update
billing_name
string | null
required
billing_address
object | null
required
invoice_number
string
required
is_invoice_generated
boolean
required
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
user_id
string<uuid4>
required
deprecated
product
object | null
required
subscription
object | null
required
items
OrderItemSchema · object[]
required
description
string
required
Examples:
seats
integer | null
next_payment_attempt_at
string<date-time> | null