Create Order

POST

orders

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.orders.create(
    customer_id='00000000-0000-4000-8000-000000000000',
    product_id='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.orders.create(
  {
    "customer_id": "00000000-0000-4000-8000-000000000000",
    "product_id": "00000000-0000-4000-8000-000000000000"
  },
);
console.log(response);

curl --request POST \
  --url https://api.polar.sh/v1/orders/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "<string>",
  "product_id": "<string>",
  "custom_field_data": {},
  "metadata": {},
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "currency": "<string>",
  "amount": 1,
  "units": 1073741824,
  "description": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer_id: '<string>',
    product_id: '<string>',
    custom_field_data: {},
    metadata: {},
    organization_id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    currency: '<string>',
    amount: 1,
    units: 1073741824,
    description: '<string>'
  })
};

fetch('https://api.polar.sh/v1/orders/', 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/orders/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer_id' => '<string>',
    'product_id' => '<string>',
    'custom_field_data' => [
        
    ],
    'metadata' => [
        
    ],
    'organization_id' => '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    'currency' => '<string>',
    'amount' => 1,
    'units' => 1073741824,
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.polar.sh/v1/orders/"

	payload := strings.NewReader("{\n  \"customer_id\": \"<string>\",\n  \"product_id\": \"<string>\",\n  \"custom_field_data\": {},\n  \"metadata\": {},\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"currency\": \"<string>\",\n  \"amount\": 1,\n  \"units\": 1073741824,\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.polar.sh/v1/orders/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"<string>\",\n  \"product_id\": \"<string>\",\n  \"custom_field_data\": {},\n  \"metadata\": {},\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"currency\": \"<string>\",\n  \"amount\": 1,\n  \"units\": 1073741824,\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/orders/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_id\": \"<string>\",\n  \"product_id\": \"<string>\",\n  \"custom_field_data\": {},\n  \"metadata\": {},\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"currency\": \"<string>\",\n  \"amount\": 1,\n  \"units\": 1073741824,\n  \"description\": \"<string>\"\n}"

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>",
  "metadata": {},
  "platform_fee_amount": 500,
  "platform_fee_currency": "usd",
  "customer": {
    "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    "created_at": "2026-01-01T00:00:00.000000Z",
    "modified_at": "2026-01-01T00:00:00.000000Z",
    "metadata": {},
    "email_verified": true,
    "type": "individual",
    "name": "John Doe",
    "billing_name": "John Doe",
    "billing_address": {
      "country": "US",
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>"
    },
    "tax_id": {
      "[0]": "<string>"
    },
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    "deleted_at": "2026-01-01T00:00:00.000000Z",
    "first_user_event_at": "2026-01-01T00:00:00.000000Z",
    "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404",
    "external_id": "usr_1337",
    "email": "[email protected]",
    "locale": "<string>",
    "default_payment_method_id": "<string>"
  },
  "product": {
    "metadata": {},
    "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>",
    "catalog_id": "<string>",
    "is_current": true
  },
  "discount": {
    "duration": "once",
    "type": "fixed",
    "amounts": {
      "eur": 900,
      "usd": 1000
    },
    "created_at": "2026-01-01T00:00:00.000000Z",
    "modified_at": "2026-01-01T00:00:00.000000Z",
    "id": "<string>",
    "external_id": "ext_1337",
    "metadata": {},
    "name": "<string>",
    "code": "<string>",
    "starts_at": "2026-01-01T00:00:00.000000Z",
    "ends_at": "2026-01-01T00:00:00.000000Z",
    "max_redemptions": 123,
    "max_redemptions_per_customer": 123,
    "redemptions_count": 123,
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
  },
  "subscription": {
    "metadata": {},
    "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",
  "custom_field_data": {}
}

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

Authorizations

Authorization

string

header

required

You can generate a Personal Access Token from your settings.

Scopes

orders:write

pat

orders:write

oat

Body

application/json

Schema to create a draft order for an off-session charge.

customer_id

string<uuid4>

required

The ID of the customer the order is for. Must belong to the order's organization.

product_id

string<uuid4>

required

The ID of the one-time product to charge for. Must belong to the order's organization. Only fixed-price, free and unit-based products are supported.

custom_field_data

Custom Field Data · object

Key-value object storing custom field values.

Show child attributes

metadata

Metadata · object

Key-value object allowing you to store additional information.

The key must be a string with a maximum length of 40 characters. The value must be either:

A string with a maximum length of 500 characters
An integer
A floating-point number
A boolean

You can store up to 50 key-value pairs.

Show child attributes

organization_id

string<uuid4> | null

The organization ID.

Example:

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

currency

string | null

The currency to charge in (ISO 4217, lowercase, e.g. usd). Defaults to the organization's default currency; specify it to force a different one, or when the product isn't priced in the organization's default currency.

amount

integer | null

A custom amount to charge, in the smallest currency unit. Overrides the product's price; defaults to the product's configured price (0 for free products). A positive amount must be at least the currency's minimum. Can't be combined with units.

Required range: x >= 0

units

integer | null

The number of units to charge for. Required when the product has unit-based pricing, and rejected otherwise. The amount comes from the price's tiers. Can't be combined with amount.

Required range: 1 <= x <= 2147483647

description

string | null

A custom description for the order's line item, shown on the invoice and receipt (e.g. 5,000 tokens). Defaults to the product name.

Maximum string length: 500

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

metadata

object

required

Show child attributes

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

Show child attributes

product

OrderProduct · object | null

required

Show child attributes

discount

DiscountFixedOnceForeverDurationBase · object

required

DiscountFixedOnceForeverDurationBase
DiscountFixedRepeatDurationBase
DiscountPercentageOnceForeverDurationBase
DiscountPercentageRepeatDurationBase

Show child attributes

subscription

OrderSubscription · 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"

custom_field_data

Custom Field Data · object

Key-value object storing custom field values.

Show child attributes

⌘I

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.orders.create(
    customer_id='00000000-0000-4000-8000-000000000000',
    product_id='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.orders.create(
  {
    "customer_id": "00000000-0000-4000-8000-000000000000",
    "product_id": "00000000-0000-4000-8000-000000000000"
  },
);
console.log(response);

curl --request POST \
  --url https://api.polar.sh/v1/orders/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "<string>",
  "product_id": "<string>",
  "custom_field_data": {},
  "metadata": {},
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "currency": "<string>",
  "amount": 1,
  "units": 1073741824,
  "description": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer_id: '<string>',
    product_id: '<string>',
    custom_field_data: {},
    metadata: {},
    organization_id: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    currency: '<string>',
    amount: 1,
    units: 1073741824,
    description: '<string>'
  })
};

fetch('https://api.polar.sh/v1/orders/', 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/orders/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer_id' => '<string>',
    'product_id' => '<string>',
    'custom_field_data' => [
        
    ],
    'metadata' => [
        
    ],
    'organization_id' => '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    'currency' => '<string>',
    'amount' => 1,
    'units' => 1073741824,
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.polar.sh/v1/orders/"

	payload := strings.NewReader("{\n  \"customer_id\": \"<string>\",\n  \"product_id\": \"<string>\",\n  \"custom_field_data\": {},\n  \"metadata\": {},\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"currency\": \"<string>\",\n  \"amount\": 1,\n  \"units\": 1073741824,\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.polar.sh/v1/orders/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"<string>\",\n  \"product_id\": \"<string>\",\n  \"custom_field_data\": {},\n  \"metadata\": {},\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"currency\": \"<string>\",\n  \"amount\": 1,\n  \"units\": 1073741824,\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/orders/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_id\": \"<string>\",\n  \"product_id\": \"<string>\",\n  \"custom_field_data\": {},\n  \"metadata\": {},\n  \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n  \"currency\": \"<string>\",\n  \"amount\": 1,\n  \"units\": 1073741824,\n  \"description\": \"<string>\"\n}"

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>",
  "metadata": {},
  "platform_fee_amount": 500,
  "platform_fee_currency": "usd",
  "customer": {
    "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    "created_at": "2026-01-01T00:00:00.000000Z",
    "modified_at": "2026-01-01T00:00:00.000000Z",
    "metadata": {},
    "email_verified": true,
    "type": "individual",
    "name": "John Doe",
    "billing_name": "John Doe",
    "billing_address": {
      "country": "US",
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>"
    },
    "tax_id": {
      "[0]": "<string>"
    },
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    "deleted_at": "2026-01-01T00:00:00.000000Z",
    "first_user_event_at": "2026-01-01T00:00:00.000000Z",
    "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404",
    "external_id": "usr_1337",
    "email": "[email protected]",
    "locale": "<string>",
    "default_payment_method_id": "<string>"
  },
  "product": {
    "metadata": {},
    "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>",
    "catalog_id": "<string>",
    "is_current": true
  },
  "discount": {
    "duration": "once",
    "type": "fixed",
    "amounts": {
      "eur": 900,
      "usd": 1000
    },
    "created_at": "2026-01-01T00:00:00.000000Z",
    "modified_at": "2026-01-01T00:00:00.000000Z",
    "id": "<string>",
    "external_id": "ext_1337",
    "metadata": {},
    "name": "<string>",
    "code": "<string>",
    "starts_at": "2026-01-01T00:00:00.000000Z",
    "ends_at": "2026-01-01T00:00:00.000000Z",
    "max_redemptions": 123,
    "max_redemptions_per_customer": 123,
    "redemptions_count": 123,
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
  },
  "subscription": {
    "metadata": {},
    "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",
  "custom_field_data": {}
}

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

General

Core API

Customer Portal API

Webhook Events

Integrations

Create Order

Authorizations

Scopes

Body

Response