Skip to main content
API docs by Redocly

Cart (1.0)

Download OpenAPI specification:Download

License: Nexway License Version 1.0

API to manage carts

Cart

Get items

Authorizations:
Bearer
query Parameters
required
object (Pageable)
predicate
required
object
target
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Create an item

Create a cart with PrivateCartInput content in the request body

Authorizations:
Bearer
Request Body schema: application/json
required
Subscription Id
string
billingPlanId
string
billingPlanPeriod
string
blockDiscounts
boolean

Block discounts on this cart

object (BuyerBehavior)

Buyer behavior

catalogId
string

Catalog ID

checkoutUrl
string

Full URL of cart

object (ConsentFlags)

Consent flags

country
required
string

Country of cart

discounts
Array of strings

List of signed discounts

object (EndUserPut)

End-user who owns this cart

enduserId
string
externalContext
string

External context

object (Flags)

Set of customer specific flags

forcedCurrency
string

Currency forced by end user

hideCrossSell
boolean
Default: false

Define if we display cross sell recommendation

hideUpSell
boolean
Default: false

Define if we display upsell recommendation

initialOrderId
string
Deprecated
ip
string

Cart IP

keepNonRecurringPaymentMethods
boolean

All payment methods are needed for the subscription shopping cart

locale
required
string

Locale of cart

marketingCampaignNames
Array of strings

List of marketing campaign name

onPaymentClickRedirectUrl
string

redirection url once payment page is closed

partialPaymentAmount
number <double>
paymentExternalContext
string
paymentMethod
string

Selected payment method

productRecoId
string

Product recommendation id

object
Array of objects (Remitted)

List of remitteds

salesFlags
Array of strings

List of sales flags

scenario
string

To be able to display different elements in the order workflow

source
string
Enum: "PURCHASE" "SUBSCRIPTION" "MANUAL_RENEWAL" "BILLING_PLAN" "OFFER" "MID_TERM_UPGRADE" "UPGRADE"

Source

storeHostname
string

Hostname of store

storeId
required
string

Reference ID of the store service

subscriptionGeneration
integer <int32>

subscription generation to use to get the public product.

subscriptionSubSource
string
Enum: "TRIAL_CONVERSION" "RENEWAL"

Purchase's sub source

useStrikeThroughPrice
boolean

use strike through price

userAgent
string

User-Agent

required
Array of objects (ProductInput) unique

list of products or signed product in the cart with its quantity and price function parameters

Responses

Request samples

Content type
application/json
{
  • "Subscription Id": "string",
  • "billingPlanId": "string",
  • "billingPlanPeriod": "string",
  • "blockDiscounts": true,
  • "buyerBehavior": {
    },
  • "catalogId": "21c6e727-3df5-45c1-9872-66c6af3c5e61",
  • "checkoutUrl": "https://storename.mydomain.fr",
  • "consentFlags": {
    },
  • "country": "FR",
  • "discounts": [
    ],
  • "endUser": {
    },
  • "enduserId": "string",
  • "externalContext": "my external context",
  • "flags": {
    },
  • "forcedCurrency": "EUR",
  • "hideCrossSell": false,
  • "hideUpSell": false,
  • "initialOrderId": "string",
  • "ip": "127.0.0.1",
  • "keepNonRecurringPaymentMethods": true,
  • "locale": "fr-FR",
  • "marketingCampaignNames": [
    ],
  • "onPaymentClickRedirectUrl": "https://www.myredirecturl.com",
  • "partialPaymentAmount": 0.1,
  • "paymentExternalContext": "string",
  • "paymentMethod": "payPal",
  • "productRecoId": "21c6e727-3df5-45c1-9872-66c6af3c5e61",
  • "products": {
    },
  • "remitteds": [
    ],
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "source": "SUBSCRIPTION",
  • "storeHostname": "storename.mydomain.fr",
  • "storeId": "string",
  • "subscriptionGeneration": 0,
  • "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
  • "useStrikeThroughPrice": true,
  • "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/535.1 (KHTML, like Gecko) Chrome/13.0.782.112 Safari/535.1",
  • "wantedProducts": [
    ]
}

Response samples

Content type
application/json
{
  • "availableCurrencies": "[EUR,USD]",
  • "billingPlanId": "string",
  • "billingPlanPeriod": "string",
  • "blockDiscounts": true,
  • "buyerBehavior": {
    },
  • "cancelPeriod": 0,
  • "cartIp": "string",
  • "catalogId": "string",
  • "checkoutUrl": "string",
  • "consentFlags": {
    },
  • "country": "FR",
  • "createDate": "2019-08-24T14:15:22Z",
  • "currency": {
    },
  • "customerId": "string",
  • "dbVersion": 0,
  • "discounts": [
    ],
  • "discountsStatus": [
    ],
  • "ecommerceToken": "string",
  • "eligibleFeatures": {
    },
  • "endUser": {
    },
  • "endUserDiscountAmountByCurrency": {
    },
  • "endUserDiscounts": [
    ],
  • "enduserId": "string",
  • "externalContext": "string",
  • "flags": {
    },
  • "forcedCurrency": "EUR",
  • "hideCrossSell": false,
  • "hideUpSell": false,
  • "id": "string",
  • "installments": [
    ],
  • "keepNonRecurringPaymentMethods": true,
  • "lastUpdateReason": "string",
  • "layout": "subscription | trial",
  • "locale": "fr-FR",
  • "manualUpdateDate": "2019-08-24T14:15:22Z",
  • "marketingCampaignNames": [
    ],
  • "maxPartialPaymentAmount": 0.1,
  • "maxPaymentsParts": 0,
  • "minPartialPaymentAmount": 0.1,
  • "modelVersion": "string",
  • "notReadyForOrderCauseMessage": "string",
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "string",
  • "orderId": "string",
  • "paymentMethod": "credit_card",
  • "paymentTypes": [
    ],
  • "piiDataSecureToken": "string",
  • "price": {
    },
  • "productRecoId": "string",
  • "products": [
    ],
  • "promoteOneClickPayment": true,
  • "remitteds": [
    ],
  • "renewalSource": true,
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "scheduledSuppressionDate": "2019-08-24T14:15:22Z",
  • "sentEmails": [
    ],
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER",
  • "storeHostname": "string",
  • "storeId": "df8ad22a-5038-11eb-ae93-0242ac130002",
  • "subscriptionGeneration": 0,
  • "subscriptionId": "string",
  • "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
  • "taxAuthority": "AVALARA",
  • "taxTransactionId": "string",
  • "taxTypes": [
    ],
  • "totalAmount": 0.1,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "useStrikeThroughPrice": true,
  • "userAgent": "string",
  • "vatNumber": "string",
  • "vouchers": [
    ],
  • "vouchersTotalAmount": 0.1,
  • "wantedProducts": [
    ],
  • "warnings": [
    ]
}

Create checkout

Create cart with products which are not in the actual catalog, will create new catalog and set the id of these products with created catalog as prefix

Authorizations:
Bearer
Request Body schema: application/json
required
required
object (PrivateCartInput)
required
object (FullCatalog)

Responses

Request samples

Content type
application/json
{
  • "cart": {
    },
  • "fullCatalog": {
    }
}

Response samples

Content type
application/json
{
  • "availableCurrencies": "[EUR,USD]",
  • "billingPlanId": "string",
  • "billingPlanPeriod": "string",
  • "blockDiscounts": true,
  • "buyerBehavior": {
    },
  • "cancelPeriod": 0,
  • "cartIp": "string",
  • "catalogId": "string",
  • "checkoutUrl": "string",
  • "consentFlags": {
    },
  • "country": "FR",
  • "createDate": "2019-08-24T14:15:22Z",
  • "currency": {
    },
  • "customerId": "string",
  • "dbVersion": 0,
  • "discounts": [
    ],
  • "discountsStatus": [
    ],
  • "ecommerceToken": "string",
  • "eligibleFeatures": {
    },
  • "endUser": {
    },
  • "endUserDiscountAmountByCurrency": {
    },
  • "endUserDiscounts": [
    ],
  • "enduserId": "string",
  • "externalContext": "string",
  • "flags": {
    },
  • "forcedCurrency": "EUR",
  • "hideCrossSell": false,
  • "hideUpSell": false,
  • "id": "string",
  • "installments": [
    ],
  • "keepNonRecurringPaymentMethods": true,
  • "lastUpdateReason": "string",
  • "layout": "subscription | trial",
  • "locale": "fr-FR",
  • "manualUpdateDate": "2019-08-24T14:15:22Z",
  • "marketingCampaignNames": [
    ],
  • "maxPartialPaymentAmount": 0.1,
  • "maxPaymentsParts": 0,
  • "minPartialPaymentAmount": 0.1,
  • "modelVersion": "string",
  • "notReadyForOrderCauseMessage": "string",
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "string",
  • "orderId": "string",
  • "paymentMethod": "credit_card",
  • "paymentTypes": [
    ],
  • "piiDataSecureToken": "string",
  • "price": {
    },
  • "productRecoId": "string",
  • "products": [
    ],
  • "promoteOneClickPayment": true,
  • "remitteds": [
    ],
  • "renewalSource": true,
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "scheduledSuppressionDate": "2019-08-24T14:15:22Z",
  • "sentEmails": [
    ],
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER",
  • "storeHostname": "string",
  • "storeId": "df8ad22a-5038-11eb-ae93-0242ac130002",
  • "subscriptionGeneration": 0,
  • "subscriptionId": "string",
  • "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
  • "taxAuthority": "AVALARA",
  • "taxTransactionId": "string",
  • "taxTypes": [
    ],
  • "totalAmount": 0.1,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "useStrikeThroughPrice": true,
  • "userAgent": "string",
  • "vatNumber": "string",
  • "vouchers": [
    ],
  • "vouchersTotalAmount": 0.1,
  • "wantedProducts": [
    ],
  • "warnings": [
    ]
}

Get distinct values for a given field

Authorizations:
Bearer
query Parameters
target
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Create a mid term upgrade

Create a Cart with a mid term upgrade for a subscription

Authorizations:
Bearer
Request Body schema: application/json
required
externalContext
string

External context

subscriptionId
required
string
required
object (ProductInput)

Responses

Request samples

Content type
application/json
{
  • "externalContext": "string",
  • "subscriptionId": "string",
  • "wantedProduct": {
    }
}

Response samples

Content type
application/json
{
  • "availableCurrencies": "[EUR,USD]",
  • "billingPlanId": "string",
  • "billingPlanPeriod": "string",
  • "blockDiscounts": true,
  • "buyerBehavior": {
    },
  • "cancelPeriod": 0,
  • "cartIp": "string",
  • "catalogId": "string",
  • "checkoutUrl": "string",
  • "consentFlags": {
    },
  • "country": "FR",
  • "createDate": "2019-08-24T14:15:22Z",
  • "currency": {
    },
  • "customerId": "string",
  • "dbVersion": 0,
  • "discounts": [
    ],
  • "discountsStatus": [
    ],
  • "ecommerceToken": "string",
  • "eligibleFeatures": {
    },
  • "endUser": {
    },
  • "endUserDiscountAmountByCurrency": {
    },
  • "endUserDiscounts": [
    ],
  • "enduserId": "string",
  • "externalContext": "string",
  • "flags": {
    },
  • "forcedCurrency": "EUR",
  • "hideCrossSell": false,
  • "hideUpSell": false,
  • "id": "string",
  • "installments": [
    ],
  • "keepNonRecurringPaymentMethods": true,
  • "lastUpdateReason": "string",
  • "layout": "subscription | trial",
  • "locale": "fr-FR",
  • "manualUpdateDate": "2019-08-24T14:15:22Z",
  • "marketingCampaignNames": [
    ],
  • "maxPartialPaymentAmount": 0.1,
  • "maxPaymentsParts": 0,
  • "minPartialPaymentAmount": 0.1,
  • "modelVersion": "string",
  • "notReadyForOrderCauseMessage": "string",
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "string",
  • "orderId": "string",
  • "paymentMethod": "credit_card",
  • "paymentTypes": [
    ],
  • "piiDataSecureToken": "string",
  • "price": {
    },
  • "productRecoId": "string",
  • "products": [
    ],
  • "promoteOneClickPayment": true,
  • "remitteds": [
    ],
  • "renewalSource": true,
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "scheduledSuppressionDate": "2019-08-24T14:15:22Z",
  • "sentEmails": [
    ],
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER",
  • "storeHostname": "string",
  • "storeId": "df8ad22a-5038-11eb-ae93-0242ac130002",
  • "subscriptionGeneration": 0,
  • "subscriptionId": "string",
  • "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
  • "taxAuthority": "AVALARA",
  • "taxTransactionId": "string",
  • "taxTypes": [
    ],
  • "totalAmount": 0.1,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "useStrikeThroughPrice": true,
  • "userAgent": "string",
  • "vatNumber": "string",
  • "vouchers": [
    ],
  • "vouchersTotalAmount": 0.1,
  • "wantedProducts": [
    ],
  • "warnings": [
    ]
}

Get recap quantities for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Create a Subscription Offer

Create a Cart with a discounted offer for a subscription

Authorizations:
Bearer
Request Body schema: application/json
required
externalContext
string
subscriptionId
required
string
useStrikeThroughPrice
boolean

Responses

Request samples

Content type
application/json
{
  • "externalContext": "string",
  • "subscriptionId": "string",
  • "useStrikeThroughPrice": true
}

Response samples

Content type
application/json
{
  • "cartId": "string",
  • "customerId": "string",
  • "externalContext": "string",
  • "offerSubSource": "string",
  • "product": {
    },
  • "source": "string",
  • "storeId": "string",
  • "subscriptionId": "string",
  • "totalAmount": 0.1,
  • "warnings": [
    ]
}

Search unwind for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "number": 0,
  • "size": 0,
  • "totalItems": 0,
  • "totalPages": 0
}

Delete item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "availableCurrencies": "[EUR,USD]",
  • "billingPlanId": "string",
  • "billingPlanPeriod": "string",
  • "blockDiscounts": true,
  • "buyerBehavior": {
    },
  • "cancelPeriod": 0,
  • "cartIp": "string",
  • "catalogId": "string",
  • "checkoutUrl": "string",
  • "consentFlags": {
    },
  • "country": "FR",
  • "createDate": "2019-08-24T14:15:22Z",
  • "currency": {
    },
  • "customerId": "string",
  • "dbVersion": 0,
  • "discounts": [
    ],
  • "discountsStatus": [
    ],
  • "ecommerceToken": "string",
  • "eligibleFeatures": {
    },
  • "endUser": {
    },
  • "endUserDiscountAmountByCurrency": {
    },
  • "endUserDiscounts": [
    ],
  • "enduserId": "string",
  • "externalContext": "string",
  • "flags": {
    },
  • "forcedCurrency": "EUR",
  • "hideCrossSell": false,
  • "hideUpSell": false,
  • "id": "string",
  • "installments": [
    ],
  • "keepNonRecurringPaymentMethods": true,
  • "lastUpdateReason": "string",
  • "layout": "subscription | trial",
  • "locale": "fr-FR",
  • "manualUpdateDate": "2019-08-24T14:15:22Z",
  • "marketingCampaignNames": [
    ],
  • "maxPartialPaymentAmount": 0.1,
  • "maxPaymentsParts": 0,
  • "minPartialPaymentAmount": 0.1,
  • "modelVersion": "string",
  • "notReadyForOrderCauseMessage": "string",
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "string",
  • "orderId": "string",
  • "paymentMethod": "credit_card",
  • "paymentTypes": [
    ],
  • "piiDataSecureToken": "string",
  • "price": {
    },
  • "productRecoId": "string",
  • "products": [
    ],
  • "promoteOneClickPayment": true,
  • "remitteds": [
    ],
  • "renewalSource": true,
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "scheduledSuppressionDate": "2019-08-24T14:15:22Z",
  • "sentEmails": [
    ],
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER",
  • "storeHostname": "string",
  • "storeId": "df8ad22a-5038-11eb-ae93-0242ac130002",
  • "subscriptionGeneration": 0,
  • "subscriptionId": "string",
  • "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
  • "taxAuthority": "AVALARA",
  • "taxTransactionId": "string",
  • "taxTypes": [
    ],
  • "totalAmount": 0.1,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "useStrikeThroughPrice": true,
  • "userAgent": "string",
  • "vatNumber": "string",
  • "vouchers": [
    ],
  • "vouchersTotalAmount": 0.1,
  • "wantedProducts": [
    ],
  • "warnings": [
    ]
}

Update products in cart

Update products for the given cart id

Authorizations:
Bearer
path Parameters
id
required
string

Cart id

query Parameters
productRecommendationId
string

Product recommendation rule id

version
integer <int64>

version

dryRun
boolean

Determine if the operation will take effect in the database, if dryRun is true, cart will not be updated

reason
string

reason of request

Request Body schema: application/json
required
crossSellBy
string

Product to cross-sell by another product

currentExpirationDate
string

Current expiration date

object (DiscountPlan)

Optional discount plan on a product

discountPlanIgnorePurchaseDiscount
boolean
discountPlanStep
integer <int32>
discountPlanTag
string
durationUntilTrialEnd
integer <int32> [ 0 .. 3 ]

Number of days before the end of trial reminder

forcedBy
string

Product to force by another product

id
required
string

Product ID

licenseId
string

License id

marketingCampaignId
string

marketing campaign id use on the product

nextExpirationDate
string

Next expiration date

parentId
string

Product parent ID

previousLineItemId
string

Previous line item ID

object

Product parameters

quantity
integer <int32>

Product quantity

quantityMaxReached
boolean

Indicator if a product quantity can not be increased (uses for the gift products in the marketing campaigns)

remotePrice
boolean
subscriptionTemplate
string
trial
boolean

Indicator if it is a product trial

upSellBy
string

Product to upsell by another product

Responses

Request samples

Content type
application/json
{
  • "crossSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
  • "currentExpirationDate": "1712906328000",
  • "discountPlan": {
    },
  • "discountPlanIgnorePurchaseDiscount": true,
  • "discountPlanStep": 0,
  • "discountPlanTag": "string",
  • "durationUntilTrialEnd": 7,
  • "forcedBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
  • "id": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
  • "licenseId": "b7df28f3-99cb-4ffe-b74e-972dca528f5a",
  • "marketingCampaignId": "string",
  • "nextExpirationDate": "1712906328000",
  • "parentId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
  • "previousLineItemId": "2a196c8f-089d-4196-a8f9-16ad61e70b25",
  • "priceFunctionParameters": {
    },
  • "quantity": 2,
  • "quantityMaxReached": false,
  • "remotePrice": true,
  • "subscriptionTemplate": "string",
  • "trial": false,
  • "upSellBy": "2a196c8f-089d-4196-a8f9-16ad61e70b25"
}

Response samples

Content type
application/json
{
  • "availableCurrencies": "[EUR,USD]",
  • "billingPlanId": "string",
  • "billingPlanPeriod": "string",
  • "blockDiscounts": true,
  • "buyerBehavior": {
    },
  • "cancelPeriod": 0,
  • "cartIp": "string",
  • "catalogId": "string",
  • "checkoutUrl": "string",
  • "consentFlags": {
    },
  • "country": "FR",
  • "createDate": "2019-08-24T14:15:22Z",
  • "currency": {
    },
  • "customerId": "string",
  • "dbVersion": 0,
  • "discounts": [
    ],
  • "discountsStatus": [
    ],
  • "ecommerceToken": "string",
  • "eligibleFeatures": {
    },
  • "endUser": {
    },
  • "endUserDiscountAmountByCurrency": {
    },
  • "endUserDiscounts": [
    ],
  • "enduserId": "string",
  • "externalContext": "string",
  • "flags": {
    },
  • "forcedCurrency": "EUR",
  • "hideCrossSell": false,
  • "hideUpSell": false,
  • "id": "string",
  • "installments": [
    ],
  • "keepNonRecurringPaymentMethods": true,
  • "lastUpdateReason": "string",
  • "layout": "subscription | trial",
  • "locale": "fr-FR",
  • "manualUpdateDate": "2019-08-24T14:15:22Z",
  • "marketingCampaignNames": [
    ],
  • "maxPartialPaymentAmount": 0.1,
  • "maxPaymentsParts": 0,
  • "minPartialPaymentAmount": 0.1,
  • "modelVersion": "string",
  • "notReadyForOrderCauseMessage": "string",
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "string",
  • "orderId": "string",
  • "paymentMethod": "credit_card",
  • "paymentTypes": [
    ],
  • "piiDataSecureToken": "string",
  • "price": {
    },
  • "productRecoId": "string",
  • "products": [
    ],
  • "promoteOneClickPayment": true,
  • "remitteds": [
    ],
  • "renewalSource": true,
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "scheduledSuppressionDate": "2019-08-24T14:15:22Z",
  • "sentEmails": [
    ],
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER",
  • "storeHostname": "string",
  • "storeId": "df8ad22a-5038-11eb-ae93-0242ac130002",
  • "subscriptionGeneration": 0,
  • "subscriptionId": "string",
  • "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
  • "taxAuthority": "AVALARA",
  • "taxTransactionId": "string",
  • "taxTypes": [
    ],
  • "totalAmount": 0.1,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "useStrikeThroughPrice": true,
  • "userAgent": "string",
  • "vatNumber": "string",
  • "vouchers": [
    ],
  • "vouchersTotalAmount": 0.1,
  • "wantedProducts": [
    ],
  • "warnings": [
    ]
}

Public

Create a cart

Create a cart with CartInput content in the request body

Authorizations:
None
query Parameters
dryRun
boolean

Determine if the operation will take effect in the database, if dryRun is true, cart will not be created

reason
string

reason of request

Request Body schema: application/json
required
Subscription Id
string
blockDiscounts
boolean

Block discounts on this cart

object (BuyerBehavior)

Buyer behavior

catalogId
string

Catalog ID

checkoutUrl
string

Full URL of cart

object (ConsentFlags)

Consent flags

country
required
string

Country of cart

discounts
Array of strings

List of signed discounts

object (EndUserPut)

End-user who owns this cart

externalContext
string

External context

object (Flags)

Set of customer specific flags

forcedCurrency
string

Currency forced by end user

hideCrossSell
boolean
Default: false

Define if we display cross sell recommendation

hideUpSell
boolean
Default: false

Define if we display upsell recommendation

initialOrderId
string
Deprecated
ip
string

Cart IP

keepNonRecurringPaymentMethods
boolean

All payment methods are needed for the subscription shopping cart

locale
required
string

Locale of cart

marketingCampaignNames
Array of strings

List of marketing campaign name

onPaymentClickRedirectUrl
string

redirection url once payment page is closed

partialPaymentAmount
number <double>
paymentExternalContext
string
paymentMethod
string

Selected payment method

productRecoId
string

Product recommendation id

object
Array of objects (Remitted)

List of remitteds

salesFlags
Array of strings

List of sales flags

scenario
string

To be able to display different elements in the order workflow

source
string
Enum: "PURCHASE" "SUBSCRIPTION" "MANUAL_RENEWAL" "BILLING_PLAN" "OFFER" "MID_TERM_UPGRADE" "UPGRADE"

Source

storeHostname
string

Hostname of store

storeId
required
string

Reference ID of the store service

subscriptionSubSource
string
Enum: "TRIAL_CONVERSION" "RENEWAL"

Purchase's sub source

useStrikeThroughPrice
boolean

use strike through price

userAgent
string

User-Agent

required
Array of objects (ProductInput) unique

list of products or signed product in the cart with its quantity and price function parameters

Responses

Request samples

Content type
application/json
{
  • "Subscription Id": "string",
  • "blockDiscounts": true,
  • "buyerBehavior": {
    },
  • "catalogId": "21c6e727-3df5-45c1-9872-66c6af3c5e61",
  • "checkoutUrl": "https://storename.mydomain.fr",
  • "consentFlags": {
    },
  • "country": "FR",
  • "discounts": [
    ],
  • "endUser": {
    },
  • "externalContext": "my external context",
  • "flags": {
    },
  • "forcedCurrency": "EUR",
  • "hideCrossSell": false,
  • "hideUpSell": false,
  • "initialOrderId": "string",
  • "ip": "127.0.0.1",
  • "keepNonRecurringPaymentMethods": true,
  • "locale": "fr-FR",
  • "marketingCampaignNames": [
    ],
  • "onPaymentClickRedirectUrl": "https://www.myredirecturl.com",
  • "partialPaymentAmount": 0.1,
  • "paymentExternalContext": "string",
  • "paymentMethod": "payPal",
  • "productRecoId": "21c6e727-3df5-45c1-9872-66c6af3c5e61",
  • "products": {
    },
  • "remitteds": [
    ],
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "source": "SUBSCRIPTION",
  • "storeHostname": "storename.mydomain.fr",
  • "storeId": "string",
  • "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
  • "useStrikeThroughPrice": true,
  • "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/535.1 (KHTML, like Gecko) Chrome/13.0.782.112 Safari/535.1",
  • "wantedProducts": [
    ]
}

Get product variant matrix

Get matrix of all available product variants of given product id, such as seats, subscription information

Authorizations:
None
path Parameters
productId
required
string

Product id

Responses

Response samples

Content type
application/json
{ }

create a product upgrade cart

create a product upgrade cart

Authorizations:
None
Request Body schema: application/json
required
previousLineItemId
required
string
upgradeProductId
required
string
upgradeRecoId
string

Responses

Request samples

Content type
application/json
{
  • "previousLineItemId": "string",
  • "upgradeProductId": "string",
  • "upgradeRecoId": "string"
}

Response samples

Content type
application/json
{
  • "availableCurrencies": "[EUR,USD]",
  • "billingPlanId": "string",
  • "billingPlanPeriod": "string",
  • "blockDiscounts": true,
  • "buyerBehavior": {
    },
  • "cancelPeriod": 0,
  • "cartIp": "string",
  • "catalogId": "string",
  • "checkoutUrl": "string",
  • "consentFlags": {
    },
  • "country": "FR",
  • "createDate": "2019-08-24T14:15:22Z",
  • "currency": {
    },
  • "customerId": "string",
  • "dbVersion": 0,
  • "discounts": [
    ],
  • "discountsStatus": [
    ],
  • "ecommerceToken": "string",
  • "eligibleFeatures": {
    },
  • "endUser": {
    },
  • "endUserDiscountAmountByCurrency": {
    },
  • "endUserDiscounts": [
    ],
  • "enduserId": "string",
  • "externalContext": "string",
  • "flags": {
    },
  • "forcedCurrency": "EUR",
  • "hideCrossSell": false,
  • "hideUpSell": false,
  • "id": "string",
  • "installments": [
    ],
  • "keepNonRecurringPaymentMethods": true,
  • "lastUpdateReason": "string",
  • "layout": "subscription | trial",
  • "locale": "fr-FR",
  • "manualUpdateDate": "2019-08-24T14:15:22Z",
  • "marketingCampaignNames": [
    ],
  • "maxPartialPaymentAmount": 0.1,
  • "maxPaymentsParts": 0,
  • "minPartialPaymentAmount": 0.1,
  • "modelVersion": "string",
  • "notReadyForOrderCauseMessage": "string",
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "string",
  • "orderId": "string",
  • "paymentMethod": "credit_card",
  • "paymentTypes": [
    ],
  • "piiDataSecureToken": "string",
  • "price": {
    },
  • "productRecoId": "string",
  • "products": [
    ],
  • "promoteOneClickPayment": true,
  • "remitteds": [
    ],
  • "renewalSource": true,
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "scheduledSuppressionDate": "2019-08-24T14:15:22Z",
  • "sentEmails": [
    ],
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER",
  • "storeHostname": "string",
  • "storeId": "df8ad22a-5038-11eb-ae93-0242ac130002",
  • "subscriptionGeneration": 0,
  • "subscriptionId": "string",
  • "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
  • "taxAuthority": "AVALARA",
  • "taxTransactionId": "string",
  • "taxTypes": [
    ],
  • "totalAmount": 0.1,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "useStrikeThroughPrice": true,
  • "userAgent": "string",
  • "vatNumber": "string",
  • "vouchers": [
    ],
  • "vouchersTotalAmount": 0.1,
  • "wantedProducts": [
    ],
  • "warnings": [
    ]
}

Get the additional expected fields for a country

Get the additional expected fields with a valid ISO 3166-1 alpha-2 code

Authorizations:
None
path Parameters
country
required
string

ISO 3166-1 alpha-2 code

Responses

Response samples

Content type
application/json
{
  • "additionalFieldAttributes": [
    ],
  • "endUserFieldRequirements": [
    ],
  • "endUserFieldsRequiredForPaymentMethod": {
    }
}

Get a cart by ID

Get a cart by ID, can customize response whether we want the full fields of response data or not with 'format' parameter

Authorizations:
None
path Parameters
id
required
string

Cart id

query Parameters
format
string
Example: format=full, short

According the format, the data returned will be filtered, full means all available data are returned.

piiDataSecureToken
string

If secure token feature was activated for customer, this parameter should have token created when cart was created. Otherwise, end user information will not be present in response

Responses

Response samples

Content type
application/json
{
  • "availableCurrencies": "[EUR,USD]",
  • "billingPlanId": "string",
  • "billingPlanPeriod": "string",
  • "blockDiscounts": true,
  • "buyerBehavior": {
    },
  • "cancelPeriod": 0,
  • "cartIp": "string",
  • "catalogId": "string",
  • "checkoutUrl": "string",
  • "consentFlags": {
    },
  • "country": "FR",
  • "createDate": "2019-08-24T14:15:22Z",
  • "currency": {
    },
  • "customerId": "string",
  • "dbVersion": 0,
  • "discounts": [
    ],
  • "discountsStatus": [
    ],
  • "ecommerceToken": "string",
  • "eligibleFeatures": {
    },
  • "endUser": {
    },
  • "endUserDiscountAmountByCurrency": {
    },
  • "endUserDiscounts": [
    ],
  • "enduserId": "string",
  • "externalContext": "string",
  • "flags": {
    },
  • "forcedCurrency": "EUR",
  • "hideCrossSell": false,
  • "hideUpSell": false,
  • "id": "string",
  • "installments": [
    ],
  • "keepNonRecurringPaymentMethods": true,
  • "lastUpdateReason": "string",
  • "layout": "subscription | trial",
  • "locale": "fr-FR",
  • "manualUpdateDate": "2019-08-24T14:15:22Z",
  • "marketingCampaignNames": [
    ],
  • "maxPartialPaymentAmount": 0.1,
  • "maxPaymentsParts": 0,
  • "minPartialPaymentAmount": 0.1,
  • "modelVersion": "string",
  • "notReadyForOrderCauseMessage": "string",
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "string",
  • "orderId": "string",
  • "paymentMethod": "credit_card",
  • "paymentTypes": [
    ],
  • "piiDataSecureToken": "string",
  • "price": {
    },
  • "productRecoId": "string",
  • "products": [
    ],
  • "promoteOneClickPayment": true,
  • "remitteds": [
    ],
  • "renewalSource": true,
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "scheduledSuppressionDate": "2019-08-24T14:15:22Z",
  • "sentEmails": [
    ],
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER",
  • "storeHostname": "string",
  • "storeId": "df8ad22a-5038-11eb-ae93-0242ac130002",
  • "subscriptionGeneration": 0,
  • "subscriptionId": "string",
  • "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
  • "taxAuthority": "AVALARA",
  • "taxTransactionId": "string",
  • "taxTypes": [
    ],
  • "totalAmount": 0.1,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "useStrikeThroughPrice": true,
  • "userAgent": "string",
  • "vatNumber": "string",
  • "vouchers": [
    ],
  • "vouchersTotalAmount": 0.1,
  • "wantedProducts": [
    ],
  • "warnings": [
    ]
}

Update a cart

Update a given cart with CartPut information in the request body

Authorizations:
None
path Parameters
id
required
string

Cart id

query Parameters
version
integer <int64>

version

dryRun
boolean

Determine if the operation will take effect in the database, if dryRun is true, cart will not be updated

format
string
Example: format=full, short

According the format, the data returned will be filtered, full means all available data are returned.

reason
string

reason of request

Request Body schema: application/json
required
object (BuyerBehavior)

Buyer behavior

checkoutUrl
string

Full URL of cart

object (ConsentFlags)

Consent flags

country
required
string

Country of cart

discounts
Array of strings

List of signed discounts

object (EndUserPut)

End-user who owns this cart

externalContext
string

External context

forcedCurrency
string

Currency forced by end user

hideCrossSell
boolean
Default: false

Define if we display cross sell recommendation

hideUpSell
boolean
Default: false

Define if we display upsell recommendation

ip
string

Cart IP

keepNonRecurringPaymentMethods
boolean

All payment methods are needed for the subscription shopping cart

locale
required
string

Locale of cart

marketingCampaignNames
Array of strings

List of marketing campaign name

paymentMethod
string

Selected payment method

productRecoId
string

Product recommendation id

object
salesFlags
Array of strings

List of sales flags

scenario
string

To be able to display different elements in the order workflow

storeHostname
string

Hostname of store

useStrikeThroughPrice
boolean

use strike through price

userAgent
string

User-Agent

required
Array of objects (ProductInput) unique

list of products or signed product in the cart with its quantity and price function parameters

Responses

Request samples

Content type
application/json
{
  • "buyerBehavior": {
    },
  • "checkoutUrl": "https://storename.mydomain.fr",
  • "consentFlags": {
    },
  • "country": "FR",
  • "discounts": [
    ],
  • "endUser": {
    },
  • "externalContext": "my external context",
  • "forcedCurrency": "EUR",
  • "hideCrossSell": false,
  • "hideUpSell": false,
  • "ip": "127.0.0.1",
  • "keepNonRecurringPaymentMethods": true,
  • "locale": "fr-FR",
  • "marketingCampaignNames": [
    ],
  • "paymentMethod": "payPal",
  • "productRecoId": "21c6e727-3df5-45c1-9872-66c6af3c5e61",
  • "products": {
    },
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "storeHostname": "storename.mydomain.fr",
  • "useStrikeThroughPrice": true,
  • "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/535.1 (KHTML, like Gecko) Chrome/13.0.782.112 Safari/535.1",
  • "wantedProducts": [
    ]
}

Response samples

Content type
application/json
{
  • "availableCurrencies": "[EUR,USD]",
  • "billingPlanId": "string",
  • "billingPlanPeriod": "string",
  • "blockDiscounts": true,
  • "buyerBehavior": {
    },
  • "cancelPeriod": 0,
  • "cartIp": "string",
  • "catalogId": "string",
  • "checkoutUrl": "string",
  • "consentFlags": {
    },
  • "country": "FR",
  • "createDate": "2019-08-24T14:15:22Z",
  • "currency": {
    },
  • "customerId": "string",
  • "dbVersion": 0,
  • "discounts": [
    ],
  • "discountsStatus": [
    ],
  • "ecommerceToken": "string",
  • "eligibleFeatures": {
    },
  • "endUser": {
    },
  • "endUserDiscountAmountByCurrency": {
    },
  • "endUserDiscounts": [
    ],
  • "enduserId": "string",
  • "externalContext": "string",
  • "flags": {
    },
  • "forcedCurrency": "EUR",
  • "hideCrossSell": false,
  • "hideUpSell": false,
  • "id": "string",
  • "installments": [
    ],
  • "keepNonRecurringPaymentMethods": true,
  • "lastUpdateReason": "string",
  • "layout": "subscription | trial",
  • "locale": "fr-FR",
  • "manualUpdateDate": "2019-08-24T14:15:22Z",
  • "marketingCampaignNames": [
    ],
  • "maxPartialPaymentAmount": 0.1,
  • "maxPaymentsParts": 0,
  • "minPartialPaymentAmount": 0.1,
  • "modelVersion": "string",
  • "notReadyForOrderCauseMessage": "string",
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "string",
  • "orderId": "string",
  • "paymentMethod": "credit_card",
  • "paymentTypes": [
    ],
  • "piiDataSecureToken": "string",
  • "price": {
    },
  • "productRecoId": "string",
  • "products": [
    ],
  • "promoteOneClickPayment": true,
  • "remitteds": [
    ],
  • "renewalSource": true,
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "scheduledSuppressionDate": "2019-08-24T14:15:22Z",
  • "sentEmails": [
    ],
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER",
  • "storeHostname": "string",
  • "storeId": "df8ad22a-5038-11eb-ae93-0242ac130002",
  • "subscriptionGeneration": 0,
  • "subscriptionId": "string",
  • "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
  • "taxAuthority": "AVALARA",
  • "taxTransactionId": "string",
  • "taxTypes": [
    ],
  • "totalAmount": 0.1,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "useStrikeThroughPrice": true,
  • "userAgent": "string",
  • "vatNumber": "string",
  • "vouchers": [
    ],
  • "vouchersTotalAmount": 0.1,
  • "wantedProducts": [
    ],
  • "warnings": [
    ]
}

Get product custom fields for a cart by ID

Get product custom fields fora cart by ID, to store it in order.

Authorizations:
None
path Parameters
id
required
string

Cart id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the additional expected fields for a country Deprecated

Get the additional expected fields by the end user country in the given cart id

Authorizations:
None
path Parameters
id
required
string

Cart id

Responses

Response samples

Content type
application/json
{
  • "additionalFieldAttributes": [
    ],
  • "endUserFieldRequirements": [
    ],
  • "endUserFieldsRequiredForPaymentMethod": {
    }
}

Update the payment method

Update the payment method and calculate subsidiary of cart with the updated payment method

Authorizations:
None
path Parameters
id
required
string

Cart id

paymentMethod
required
string
Example: credit_card

Payment method name

Responses

Response samples

Content type
application/json
{
  • "availableCurrencies": "[EUR,USD]",
  • "billingPlanId": "string",
  • "billingPlanPeriod": "string",
  • "blockDiscounts": true,
  • "buyerBehavior": {
    },
  • "cancelPeriod": 0,
  • "cartIp": "string",
  • "catalogId": "string",
  • "checkoutUrl": "string",
  • "consentFlags": {
    },
  • "country": "FR",
  • "createDate": "2019-08-24T14:15:22Z",
  • "currency": {
    },
  • "customerId": "string",
  • "dbVersion": 0,
  • "discounts": [
    ],
  • "discountsStatus": [
    ],
  • "ecommerceToken": "string",
  • "eligibleFeatures": {
    },
  • "endUser": {
    },
  • "endUserDiscountAmountByCurrency": {
    },
  • "endUserDiscounts": [
    ],
  • "enduserId": "string",
  • "externalContext": "string",
  • "flags": {
    },
  • "forcedCurrency": "EUR",
  • "hideCrossSell": false,
  • "hideUpSell": false,
  • "id": "string",
  • "installments": [
    ],
  • "keepNonRecurringPaymentMethods": true,
  • "lastUpdateReason": "string",
  • "layout": "subscription | trial",
  • "locale": "fr-FR",
  • "manualUpdateDate": "2019-08-24T14:15:22Z",
  • "marketingCampaignNames": [
    ],
  • "maxPartialPaymentAmount": 0.1,
  • "maxPaymentsParts": 0,
  • "minPartialPaymentAmount": 0.1,
  • "modelVersion": "string",
  • "notReadyForOrderCauseMessage": "string",
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "string",
  • "orderId": "string",
  • "paymentMethod": "credit_card",
  • "paymentTypes": [
    ],
  • "piiDataSecureToken": "string",
  • "price": {
    },
  • "productRecoId": "string",
  • "products": [
    ],
  • "promoteOneClickPayment": true,
  • "remitteds": [
    ],
  • "renewalSource": true,
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "scheduledSuppressionDate": "2019-08-24T14:15:22Z",
  • "sentEmails": [
    ],
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER",
  • "storeHostname": "string",
  • "storeId": "df8ad22a-5038-11eb-ae93-0242ac130002",
  • "subscriptionGeneration": 0,
  • "subscriptionId": "string",
  • "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
  • "taxAuthority": "AVALARA",
  • "taxTransactionId": "string",
  • "taxTypes": [
    ],
  • "totalAmount": 0.1,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "useStrikeThroughPrice": true,
  • "userAgent": "string",
  • "vatNumber": "string",
  • "vouchers": [
    ],
  • "vouchersTotalAmount": 0.1,
  • "wantedProducts": [
    ],
  • "warnings": [
    ]
}

Get cart product recommendations

Get the product recommendations for the given cart id

Authorizations:
None
path Parameters
id
required
string

Cart id

Responses

Response samples

Content type
application/json
{ }

Send cart by mail

Send cart to the mail of end user in the given cart id

Authorizations:
None
path Parameters
id
required
string

Cart id

Responses

Response samples

Content type
application/json
{
  • "details": [
    ],
  • "error": "string",
  • "message": "string",
  • "status": 0,
  • "timestamp": 0
}

Update products in cart

Update products for the given cart id

Authorizations:
None
path Parameters
id
required
string

Cart id

query Parameters
productRecommendationId
string

Product recommendation rule id

version
integer <int64>

version

dryRun
boolean

Determine if the operation will take effect in the database, if dryRun is true, product in the cart will not be updated

format
string
Example: format=full, short

According the format, the data returned will be filtered, full means all available data are returned.

reason
string

reason of request

Request Body schema: application/json
required
Array
crossSellBy
string

Product to cross-sell by another product

currentExpirationDate
string

Current expiration date

object (DiscountPlan)

Optional discount plan on a product

discountPlanIgnorePurchaseDiscount
boolean
discountPlanStep
integer <int32>
discountPlanTag
string
durationUntilTrialEnd
integer <int32> [ 0 .. 3 ]

Number of days before the end of trial reminder

forcedBy
string

Product to force by another product

id
required
string

Product ID

licenseId
string

License id

marketingCampaignId
string

marketing campaign id use on the product

nextExpirationDate
string

Next expiration date

parentId
string

Product parent ID

previousLineItemId
string

Previous line item ID

object

Product parameters

quantity
integer <int32>

Product quantity

quantityMaxReached
boolean

Indicator if a product quantity can not be increased (uses for the gift products in the marketing campaigns)

remotePrice
boolean
subscriptionTemplate
string
trial
boolean

Indicator if it is a product trial

upSellBy
string

Product to upsell by another product

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "availableCurrencies": "[EUR,USD]",
  • "billingPlanId": "string",
  • "billingPlanPeriod": "string",
  • "blockDiscounts": true,
  • "buyerBehavior": {
    },
  • "cancelPeriod": 0,
  • "cartIp": "string",
  • "catalogId": "string",
  • "checkoutUrl": "string",
  • "consentFlags": {
    },
  • "country": "FR",
  • "createDate": "2019-08-24T14:15:22Z",
  • "currency": {
    },
  • "customerId": "string",
  • "dbVersion": 0,
  • "discounts": [
    ],
  • "discountsStatus": [
    ],
  • "ecommerceToken": "string",
  • "eligibleFeatures": {
    },
  • "endUser": {
    },
  • "endUserDiscountAmountByCurrency": {
    },
  • "endUserDiscounts": [
    ],
  • "enduserId": "string",
  • "externalContext": "string",
  • "flags": {
    },
  • "forcedCurrency": "EUR",
  • "hideCrossSell": false,
  • "hideUpSell": false,
  • "id": "string",
  • "installments": [
    ],
  • "keepNonRecurringPaymentMethods": true,
  • "lastUpdateReason": "string",
  • "layout": "subscription | trial",
  • "locale": "fr-FR",
  • "manualUpdateDate": "2019-08-24T14:15:22Z",
  • "marketingCampaignNames": [
    ],
  • "maxPartialPaymentAmount": 0.1,
  • "maxPaymentsParts": 0,
  • "minPartialPaymentAmount": 0.1,
  • "modelVersion": "string",
  • "notReadyForOrderCauseMessage": "string",
  • "offerSubSource": "RESUME | SUSPEND",
  • "onPaymentClickRedirectUrl": "string",
  • "orderId": "string",
  • "paymentMethod": "credit_card",
  • "paymentTypes": [
    ],
  • "piiDataSecureToken": "string",
  • "price": {
    },
  • "productRecoId": "string",
  • "products": [
    ],
  • "promoteOneClickPayment": true,
  • "remitteds": [
    ],
  • "renewalSource": true,
  • "salesFlags": [
    ],
  • "scenario": "acquisition",
  • "scheduledSuppressionDate": "2019-08-24T14:15:22Z",
  • "sentEmails": [
    ],
  • "source": "PURCHASE | SUBSCRIPTION | MANUAL_RENEWAL | BILLING_PLAN | OFFER",
  • "storeHostname": "string",
  • "storeId": "df8ad22a-5038-11eb-ae93-0242ac130002",
  • "subscriptionGeneration": 0,
  • "subscriptionId": "string",
  • "subscriptionSubSource": "TRIAL_CONVERSION,RENEWAL",
  • "taxAuthority": "AVALARA",
  • "taxTransactionId": "string",
  • "taxTypes": [
    ],
  • "totalAmount": 0.1,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "useStrikeThroughPrice": true,
  • "userAgent": "string",
  • "vatNumber": "string",
  • "vouchers": [
    ],
  • "vouchersTotalAmount": 0.1,
  • "wantedProducts": [
    ],
  • "warnings": [
    ]
}