Previews a signup order with pricing information

post

https://sandbox.billwerk.com/api/v1/orders/preview

This endpoint works very similar to POST /Orders, by returning an order object, but does not actually create the order persistently. You can pass the same data. It can be used to show pricing information of the cart. Likewise a real order creation it takes into account passed customer data like VAT ID and country to determine the actual price and taxes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Order object

StartDate

date-time | null

Determines the start date of the subscription

EndDate

date-time | null

Determines the end date of the subscription

BilledUntil

date-time | null

Determines until when the subscription has been paid

ChangeDate

date-time | null

Determines the change date for the up-/downgrade

TriggerInterimBilling

boolean

EmailTemplateExternalId

string | null

Determines the email template which will be used

CustomerId

string | null

ID of the customer

ContractId

string | null

ID of the contract

ContractDestinationCountry

string | null

DestinationCountry for Contract

Cart

object

ExternalCart

object

ExternalSubscriptionId

string | null

Customer

object

ContractCustomFields

object | null

Contains description of the contract custom fields

PreviewAfterTrial

boolean

CustomFields

object | null

Contains description of the order custom fields

SalesEntityId

string | null

ID of the sales entity

BillOnContractStartDate

boolean

Determines if contract should be billed on start date

Responses

401

Unauthorized

500

Internal Server Error

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK