OrderCreate
June 8, 2026 ยท View on GitHub
Schema to create a draft order for an off-session charge.
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
custom_field_data | Dict[str, Nullable[models.OrderCreateCustomFieldData]] | :heavy_minus_sign: | Key-value object storing custom field values. | |
metadata | Dict[str, models.OrderCreateMetadata] | :heavy_minus_sign: | 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. | |
organization_id | OptionalNullable[str] | :heavy_minus_sign: | The ID of the organization the order belongs to. Required unless you use an organization token. The customer and product must belong to this organization. | 1dbfc517-0bbf-4301-9ba8-555ca42b9737 |
customer_id | str | :heavy_check_mark: | The ID of the customer the order is for. Must belong to the order's organization. | |
product_id | str | :heavy_check_mark: | The ID of the one-time product to charge for. Must belong to the order's organization. Only fixed-price and free products are supported. | |
currency | OptionalNullable[str] | :heavy_minus_sign: | 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 | OptionalNullable[int] | :heavy_minus_sign: | 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. | |
description | OptionalNullable[str] | :heavy_minus_sign: | 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. |