--- title: "Get offer pricing" method: POST path: "/v2/user/customer/offers" tags: ["Customer - Contracts"] --- # Get offer pricing `POST /v2/user/customer/offers` Get the offer pricing then you can create your contract with the same request parameters. /v2/user/customer/contracts ## Request body - OfferRequest - `offerId` integer, required — The offer id based on /offers. Not a free offer of course. - `storeCount` integer, required — The store count you want to have in your contract. - `couponDiscountCode` string — The coupon discount code - `couponOfferCode` string, guid — Your special coupon offer identifier - `billingPeriodInMonth` integer, required — Can be null. The billing period in month based on /billingPeriods ## Response `200` Get the offer proposal considering your current contract - Offer - `content` OfferContent - `previousFixPeriodInvoiceProrataInfo` PreviousFixPeriodInvoiceProrataInfo, required — Describe the prorata info based on your previous invoice - `computedProrataToBeDeducted` number, double — The prorata amount - `invoiceNumber` string — The previous invoice number - `amountToBePaid` number, double — The amount to be payed of the previous invoice - `amountAfterTax` number, double — The amout after tax of the previous invoice - `contractId` string, guid — The contract id related to the previous invoice - `fixedPeriodEndDate` string, date — The fixed end period of the previous invoice - `fixedPeriodStartDate` string, date — The fixed start period of the previous invoice - `contractBillingPeriodInfo` ContractBillingPeriodInfo, required — Describe the billing period information related to the offer. - `amountBillingPeriodDiscount` number, double — The amount discounted related to the billing period - `billingPeriodPercentDiscount` number, double — The discount percent related to the billing period - `billingPeriodInMonth` integer — Can be null. The billing period in month based on /billingPeriods - `contractClickInfo` ContractClickInfo, required — Describe the click information related to the offer. - `additionalClickPrice` number, double — The addition click price in the offer - `clickIncluded` integer — The click included in the offer - `initialOfferClickIncluded` integer — The click included in your current contract - `contractCommitmentInfo` ContractCommitmentInfo, required — Describe the commitment information related to the offer. - `commitmentCalculatedFinishDate` string, date — The commitment end date related to the offer - `newContractStartDate` string, date-time — The start date related to the offer - `commitmentPeriodInMonth` integer — The commitment period in month related to the offer - `trialPeriodInMonth` integer — The trial period in month related to the offer - `trialPeriodFinishDate` string, date — The trial period end date related to the offer - `paymentDelayInDays` integer — The payment delay in days related to the offer - `offerId` integer — The offer id based on /offers. Not a free offer of course. - `offerName` string — The offer Name - `currentContractId` string, guid — Your current contract id - `commercialUserId` string, guid — Your current commercial user id - `model` string — Interal usage: Old offer type. The model description - `currentContractTerminationDate` string, date — The current contract termination date - `requestedPaymentMethod` 'Transfer' | 'Debit' | 'Paypal' | 'Check' | 'CreditNote' | 'Loss' | 'OnlinePayment' — Payment method - `currentCustomerPaymentMethod` 'Transfer' | 'Debit' | 'Paypal' | 'Check' | 'CreditNote' | 'Loss' | 'OnlinePayment' — Payment method - `contractType` integer — Internal usage: Old offer type. Your contract type - `isModelMustBeTransmittedInNewContract` boolean — Internal usage: Old offer type. Is the current contract model needs to be converted into a new contract type - `fixedAndVariableClickInfo` FixedAndVariableClickModelInfo — Internal usage: Old offer type. Describe the fix and variable model information - `clickIncludedAndAdditionalClickPrices` ClickIncludedAndAdditionalClickPrice[], required - `clickIncluded` integer — The click included - `additionalClickPrice` number, double — The additional click price - `variableModelInfo` VariableModelInfo — Internal usage: Old offer type. Describe the fix and variable model information - `clickIncludedAndVariablePrices` ClickIncludedAndVariablePrice[], required — Click included with variable pricing information - `clickIncluded` integer — Click included - `variablePrice` number, double — The pricing applied for this range - `overflowClickCount` integer, required — The overflow click count - `overflowClickPrice` number, double, required — The overflow click price - `paymentMethodAuthorized` 'Transfer' | 'Debit' | 'Paypal' | 'Check' | 'CreditNote' | 'Loss' | 'OnlinePayment' — Payment method - `couponOfferCode` string, guid — Your special coupon offer identifier - `commercialCreatorUserId` string, guid — The commercial that is responsible of the creation of your account - `minBillingPeriodInMonths` integer — The minimum billing period in month authorized for this offer. - `isCustomerWantsToTerminateHisContract` boolean — If true, this means you want to leave us and that's sad... :'-( - `contractDiscountInfo` ContractDiscountInfo, required — Describe the discount information related to the offer. - `amountCodePromoDiscountPerMonth` number, double — The amount discounted per month - `discountDurationInMonth` integer — Duration of the discount in month - `percentDiscount` number, double — Percentage of the discount - `promotionalCodeValidity` 'None' | 'Valid' | 'Invalid' | 'ExpiredOrInactive' — Indicate the validaty of the discount - `amountCodePromoDiscount` number, double — The discount amount - `couponDiscountCode` string — The discount code - `couponDiscountId` integer — Internal use: The discount id - `isCouponDiscountLinkedToCouponOffer` boolean — Is this discount is related to a coupon offer - `customerHasActualDiscount` boolean — Do you have currently a discount on your contract ? - `contractMoneyInfo` ContractMoneyInfo, required — Describe the pricing information related to the offer. - `amountExcludingTaxesAndExcludingCodePromoDiscountIncludingBillingPeriodDiscount` number, double — The amount excluding taxes and excluding code promo discount including billing period discount. - `amountExcludingTaxesIncludingDiscounts` number, double — The amount excluding taxes including discounts. - `amountTaxesExcludingDiscountIncludingBillingPeriodDiscount` number, double — The taxes excluding discount including billing period discount. - `amountIncludingTaxesExcludingDiscountIncludingBillingPeriodDiscount` number, double — The amount including taxes excluding discount including billing period discount. - `currencyCode` string — The currency code (ISO 4217) - `vatPercent` number, double — The VAT percent. - `amountExcludingTaxesIncludingDiscountsPerMonth` number, double — The amount excluding taxes including discounts per month. - `amountExcludingTaxesAndExcludingDiscounts` number, double — The amount excluding taxes and excluding discounts. - `amountTaxesIncludingDiscounts` number, double — Taxes including discounts. - `amountIncludingTaxesIncludingDiscounts` number, double — The amount including taxes including discounts. - `initialOfferFixedPrice` number, double — The initial offer fixed price. - `contractStoreInfo` ContractStoreInfo, required — Describe the store information related to the offer. - `storeCount` integer — The store count you want to have in your contract. - `maxStoreCount` integer — The maximum store count related to the offer. - `minStoreCount` integer — The minimum store count related to the offer. - `ownedStoreCount` integer — The owned store count. - `additionalStorePrice` number, double — The additional store price. - `storeIncluded` integer — The store count included in the offer. - `contractBonusInfo` ContractBonusInfo, required — Describe the bonus information related to your current contract. - `bonuses` BonusInfo[], required - `bonusType` 'OnlinePaymentMethodBonus' | 'PreviousInvoiceProrataBonus' | 'PreviousContractBonus', required - `amount` number, double, required - `contractTerminationReasonType` integer — The contract termination reason type identifier, if your current contract is scheduled to be terminated. The value is based on the list of values /user/lov/ContractTerminationReason - `contractTerminationReason` string — The termination reason, if your current contract is scheduled to be terminated. - `notifyVatExemption` boolean, required — Internal usage: Indicates if we have to notify you about VAT exemption. - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `links` OfferLinks — The different actions you can make on this offer - `createContract` LinksCreateContractLink - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header. - `docUrl` string, uri — The documentation related to this operation. - `description` string — The description of the link - `href` string, required — Indicate the relative uri for this link - `operationId` string — The operationId to call. - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link - `parameters` object - `urlTemplated` boolean — indicates whether the href is templated or not - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided - `info` BeezUPCommonInfoSummaries - `successes` BeezUPCommonSuccessSummary[] - `successCode` string - `successMessage` string - `successArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `errors` BeezUPCommonErrorSummary[] - `utcDate` string, date-time - `errorGuid` string, uuid - `errorCode` string - `errorMessage` string - `technicalErrorMessage` string - `exceptionDetail` BeezUPCommonExceptionDetail - `helpLink` string - `message` string - `stackTrace` string - `type` string - `errorArguments` object - `propertyName` string - `propertyValue` string - `objectName` string - `source` string - `warnings` BeezUPCommonWarningSummary[] - `technicalErrorMessage` string - `warningMessage` string - `warningCode` string - `warningArguments` object - `informations` BeezUPCommonInfoSummary[] - `informationCode` string - `informationMessage` string - `informationArguments` object - `propertyName` string - `propertyValue` string - `objectName` string ## Other responses - `400` — Bad request. (Invalid billing period, invalid offer, etc.). You cannot get a pricing for a free offer. - `403` — You current contract is not modifiable. Please choose another offer. - `default` — Occurs when something goes wrong --- [API](https://skmtc.net/beezup/apis/beezup-merchant-api.md) · [All operations](https://skmtc.net/beezup/apis/beezup-merchant-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/beezup/beezup-merchant-api/versions/557b7feddf8a/schema)