Class CheckoutOrder
Inheritance
Inherited Members
Namespace: Klarna.Rest.Core.Model
Assembly: Klarna.Rest.Core.dll
Syntax
public class CheckoutOrder
Properties
| Improve this Doc View SourceAttachment
Additional purchase information required for some industries.
Declaration
[JsonProperty(PropertyName = "attachment")]
public Attachment Attachment { get; set; }
Property Value
Type | Description |
---|---|
Attachment | Additional purchase information required for some industries. |
BillingCheckoutAddress
Once the customer has provided any data in the checkout iframe, updates to this object will be ignored (without generating an error).
Declaration
[JsonProperty(PropertyName = "billing_address")]
public CheckoutAddressInfo BillingCheckoutAddress { get; set; }
Property Value
Type | Description |
---|---|
CheckoutAddressInfo | Once the customer has provided any data in the checkout iframe, updates to this object will be ignored (without generating an error). |
BillingCountries
A list of countries (ISO 3166 alpha-2) to specify allowed billing countries.
Declaration
[JsonProperty(PropertyName = "billing_countries")]
public ICollection<string> BillingCountries { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.ICollection<System.String> | A list of countries (ISO 3166 alpha-2) to specify allowed billing countries. |
CheckoutCustomer
Information about the liable customer of the order.
Declaration
[JsonProperty(PropertyName = "customer")]
public CheckoutCustomer CheckoutCustomer { get; set; }
Property Value
Type | Description |
---|---|
CheckoutCustomer | Information about the liable customer of the order. |
CheckoutOptions
Options for this purchase.
Declaration
[JsonProperty(PropertyName = "options")]
public CheckoutOptions CheckoutOptions { get; set; }
Property Value
Type | Description |
---|---|
CheckoutOptions | Options for this purchase. |
CompletedAt
ISO 8601 datetime. When the customer completed the order.
Declaration
[JsonProperty(PropertyName = "completed_at")]
public string CompletedAt { get; set; }
Property Value
Type | Description |
---|---|
System.String | ISO 8601 datetime. When the customer completed the order. |
ExternalCheckouts
List of external checkouts.
Declaration
[JsonProperty(PropertyName = "external_checkouts")]
public ICollection<PaymentProvider> ExternalCheckouts { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.ICollection<PaymentProvider> | List of external checkouts. |
ExternalPaymentMethods
List of external payment methods.
Declaration
[JsonProperty(PropertyName = "external_payment_methods")]
public ICollection<PaymentProvider> ExternalPaymentMethods { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.ICollection<PaymentProvider> | List of external payment methods. |
Gui
The gui object.
Declaration
[JsonProperty(PropertyName = "gui")]
public Gui Gui { get; set; }
Property Value
Type | Description |
---|---|
Gui | The gui object. |
HtmlSnippet
The HTML snippet that is used to render the checkout in an iframe.
Declaration
[JsonProperty(PropertyName = "html_snippet")]
public string HtmlSnippet { get; set; }
Property Value
Type | Description |
---|---|
System.String | The HTML snippet that is used to render the checkout in an iframe. |
LastModifiedAt
ISO 8601 datetime. When the order was last modified.
Declaration
[JsonProperty(PropertyName = "last_modified_at")]
public string LastModifiedAt { get; set; }
Property Value
Type | Description |
---|---|
System.String | ISO 8601 datetime. When the order was last modified. |
Locale
RFC 1766 customer's locale.
Declaration
[JsonProperty(PropertyName = "locale")]
public string Locale { get; set; }
Property Value
Type | Description |
---|---|
System.String | RFC 1766 customer's locale. |
MerchantData
Pass through field (max 6000 characters).
Declaration
[JsonProperty(PropertyName = "merchant_data")]
public string MerchantData { get; set; }
Property Value
Type | Description |
---|---|
System.String | Pass through field (max 6000 characters). |
MerchantReference1
Used for storing merchant's internal order number or other reference. If set, will be shown on the confirmation page as "order number" (max 255 characters).
Declaration
[JsonProperty(PropertyName = "merchant_reference1")]
public string MerchantReference1 { get; set; }
Property Value
Type | Description |
---|---|
System.String | Used for storing merchant's internal order number or other reference. If set, will be shown on the confirmation page as "order number" (max 255 characters). |
MerchantReference2
Used for storing merchant's internal order number or other reference (max 255 characters).
Declaration
[JsonProperty(PropertyName = "merchant_reference2")]
public string MerchantReference2 { get; set; }
Property Value
Type | Description |
---|---|
System.String | Used for storing merchant's internal order number or other reference (max 255 characters). |
MerchantRequested
Stores merchant requested data.
Declaration
[JsonProperty(PropertyName = "merchant_requested")]
public MerchantRequested MerchantRequested { get; set; }
Property Value
Type | Description |
---|---|
MerchantRequested | Stores merchant requested data. |
MerchantUrls
The merchant_urls object.
Declaration
[JsonProperty(PropertyName = "merchant_urls")]
public CheckoutMerchantUrls MerchantUrls { get; set; }
Property Value
Type | Description |
---|---|
CheckoutMerchantUrls | The merchant_urls object. |
Name
The merchant name (max 255 characters).
Declaration
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String | The merchant name (max 255 characters). |
OrderAmount
Non-negative, minor units. Total amount of the order, including tax and any discounts.
Declaration
[JsonProperty(PropertyName = "order_amount")]
public int OrderAmount { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | Non-negative, minor units. Total amount of the order, including tax and any discounts. |
OrderId
The unique order ID (max 255 characters).
Declaration
[JsonProperty(PropertyName = "order_id")]
public string OrderId { get; set; }
Property Value
Type | Description |
---|---|
System.String | The unique order ID (max 255 characters). |
OrderLines
The applicable order lines (max 1000)
Declaration
[JsonProperty(PropertyName = "order_lines")]
public ICollection<OrderLine> OrderLines { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.ICollection<OrderLine> | The applicable order lines (max 1000) |
OrderTaxAmount
Non-negative, minor units. The total tax amount of the order.
Declaration
[JsonProperty(PropertyName = "order_tax_amount")]
public int OrderTaxAmount { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | Non-negative, minor units. The total tax amount of the order. |
PurchaseCountry
ISO 3166 alpha-2 purchase country.
Declaration
[JsonProperty(PropertyName = "purchase_country")]
public string PurchaseCountry { get; set; }
Property Value
Type | Description |
---|---|
System.String | ISO 3166 alpha-2 purchase country. |
PurchaseCurrency
ISO 4217 purchase currency.
Declaration
[JsonProperty(PropertyName = "purchase_currency")]
public string PurchaseCurrency { get; set; }
Property Value
Type | Description |
---|---|
System.String | ISO 4217 purchase currency. |
Recurring
Indicates whether this purchase will create a token that can be used by the merchant to create recurring purchases. This must be enabled for the merchant to use. Default: false
Declaration
[JsonProperty(PropertyName = "recurring")]
public bool Recurring { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | Indicates whether this purchase will create a token that can be used by the merchant to create recurring purchases. This must be enabled for the merchant to use. Default: false |
RecurringDescription
Description recurring subscription.
Declaration
[JsonProperty(PropertyName = "recurring_description")]
public string RecurringDescription { get; set; }
Property Value
Type | Description |
---|---|
System.String | Description recurring subscription. |
RecurringToken
Token to be used when creating recurring orders.
Declaration
[JsonProperty(PropertyName = "recurring_token")]
public string RecurringToken { get; set; }
Property Value
Type | Description |
---|---|
System.String | Token to be used when creating recurring orders. |
SelectedShippingOption
Current shipping options selected by the customer.
Declaration
[JsonProperty(PropertyName = "selected_shipping_option")]
public ShippingOption SelectedShippingOption { get; set; }
Property Value
Type | Description |
---|---|
ShippingOption | Current shipping options selected by the customer. |
ShippingCheckoutAddress
Unless the customer has explicitly chosen to enter a separate shipping address, this is a clone of billing_address.
Declaration
[JsonProperty(PropertyName = "shipping_address")]
public CheckoutAddressInfo ShippingCheckoutAddress { get; set; }
Property Value
Type | Description |
---|---|
CheckoutAddressInfo | Unless the customer has explicitly chosen to enter a separate shipping address, this is a clone of billing_address. |
ShippingCountries
A list of countries (ISO 3166 alpha-2). Default is purchase_country only.
Declaration
[JsonProperty(PropertyName = "shipping_countries")]
public ICollection<string> ShippingCountries { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.ICollection<System.String> | A list of countries (ISO 3166 alpha-2). Default is purchase_country only. |
ShippingOptions
A list of shipping options available for this order.
Declaration
[JsonProperty(PropertyName = "shipping_options")]
public ICollection<ShippingOption> ShippingOptions { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.ICollection<ShippingOption> | A list of shipping options available for this order. |
StartedAt
ISO 8601 datetime. When the merchant created the order.
Declaration
[JsonProperty(PropertyName = "started_at")]
public string StartedAt { get; set; }
Property Value
Type | Description |
---|---|
System.String | ISO 8601 datetime. When the merchant created the order. |
Status
The current status of the order.
Declaration
[JsonProperty(PropertyName = "status")]
public string Status { get; set; }
Property Value
Type | Description |
---|---|
System.String | The current status of the order. |
Tags
The product's extra features
Declaration
[JsonProperty(PropertyName = "tags")]
public ICollection<string> Tags { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.ICollection<System.String> | The product's extra features |