Skip to main content
PATCH
/
v1
/
orders
/
{id}
PHP (SDK)
declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$orderUpdate = new Components\OrderUpdate(
    billingAddress: new Components\AddressInput(
        country: Components\AddressInputCountryAlpha2Input::Us,
    ),
);

$response = $sdk->orders->update(
    id: '<value>',
    orderUpdate: $orderUpdate

);

if ($response->order !== null) {
    // handle response
}
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "paid": true,
  "subtotal_amount": 123,
  "discount_amount": 123,
  "net_amount": 123,
  "tax_amount": 123,
  "total_amount": 123,
  "applied_balance_amount": 123,
  "due_amount": 123,
  "refunded_amount": 123,
  "refunded_tax_amount": 123,
  "currency": "<string>",
  "billing_name": "<string>",
  "billing_address": {
    "line1": "<string>",
    "line2": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "state": "<string>"
  },
  "invoice_number": "<string>",
  "is_invoice_generated": true,
  "receipt_number": "<string>",
  "customer_id": "<string>",
  "product_id": "<string>",
  "discount_id": "<string>",
  "subscription_id": "<string>",
  "checkout_id": "<string>",
  "metadata": {},
  "platform_fee_amount": 123,
  "platform_fee_currency": "usd",
  "customer": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "email_verified": true,
    "name": "John Doe",
    "billing_address": {
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>"
    },
    "tax_id": {
      "[0]": "<string>"
    },
    "organization_id": "<string>",
    "deleted_at": "2023-11-07T05:31:56Z",
    "avatar_url": "<string>",
    "external_id": "usr_1337",
    "email": "customer@example.com",
    "locale": "<string>",
    "default_payment_method_id": "<string>"
  },
  "product": {
    "metadata": {},
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "trial_interval_count": 123,
    "name": "<string>",
    "description": "<string>",
    "recurring_interval_count": 123,
    "is_recurring": true,
    "is_archived": true,
    "organization_id": "<string>"
  },
  "discount": {
    "amount": 123,
    "currency": "<string>",
    "amounts": {},
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "metadata": {},
    "name": "<string>",
    "code": "<string>",
    "starts_at": "2023-11-07T05:31:56Z",
    "ends_at": "2023-11-07T05:31:56Z",
    "max_redemptions": 123,
    "redemptions_count": 123,
    "organization_id": "<string>"
  },
  "subscription": {
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "amount": 123,
    "currency": "<string>",
    "recurring_interval_count": 123,
    "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>",
    "customer_cancellation_comment": "<string>",
    "seats": 123
  },
  "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>"
    }
  ],
  "description": "<string>",
  "refundable_amount": 123,
  "refundable_tax_amount": 123,
  "seats": 123,
  "custom_field_data": {}
}

Authorizations

​
Authorization
string
header
required

You can generate an Organization Access Token from your organization's settings.

Path Parameters

​
id
string<uuid4>
required

The order ID.

Body

application/json

Schema to update an order.

​
billing_name
string | null

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

​
billing_address
AddressInput · object

The address of the customer that should appear on the invoice. Country and state fields cannot be updated.

Response

Successful Response

​
id
string<uuid4>
required

The ID of the object.

​
created_at
string<date-time>
required

Creation timestamp of the object.

​
modified_at
string<date-time> | null
required

Last modification timestamp of the object.

​
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
​
billing_name
string | null
required

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

​
billing_address
Address · object
required
​
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.

​
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
​
metadata
object
required
​
platform_fee_amount
integer
required

Platform fee amount in cents.

Example:

500

​
platform_fee_currency
string | null
required

Currency of the platform fee.

Example:

"usd"

​
customer
OrderCustomer · object
required
​
product
OrderProduct · object
required
​
discount
DiscountFixedOnceForeverDurationBase · object
required
​
subscription
OrderSubscription · object
required
​
items
OrderItemSchema · object[]
required

Line items composing the order.

​
description
string
required

A summary description of the order.

Example:

"Pro Plan"

​
refundable_amount
integer
required

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

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).

​
custom_field_data
Custom Field Data · object

Key-value object storing custom field values.