action beezup_get_offer {
  label: "Get offer pricing"
  description: "Get the offer pricing then you can create your contract with the same request parameters. /v2/user/customer/contracts\n"
  provider: beezup
  method: POST
  path: "/v2/user/customer/offers"
  encoding: json
  input: {
    type: "object"
    required: ["billingPeriodInMonth", "offerId", "storeCount"]
    properties: {
      billingPeriodInMonth: {
        type: "integer"
        format: "int32"
        description: "Can be null. The billing period in month based on /billingPeriods"
      }
      couponDiscountCode: {
        type: "string"
        description: "The coupon discount code"
      }
      couponOfferCode: {
        type: "string"
        format: "guid"
        description: "Your special coupon offer identifier"
      }
      offerId: {
        type: "integer"
        format: "int32"
        description: "The offer id based on /offers. Not a free offer of course."
      }
      storeCount: {
        type: "integer"
        format: "int32"
        description: "The store count you want to have in your contract."
      }
    }
  }
  output: {
    type: "object"
    properties: {
      content: {
        type: "object"
        required: ["contractBillingPeriodInfo", "contractBonusInfo", "contractClickInfo", "contractCommitmentInfo", "contractDiscountInfo", "contractMoneyInfo", "contractStoreInfo", "notifyVatExemption", "previousFixPeriodInvoiceProrataInfo"]
        properties: {
          contractBillingPeriodInfo: {
            type: "object"
            description: "Describe the billing period information related to the offer."
            properties: {
              amountBillingPeriodDiscount: {
                type: "number"
                format: "double"
                description: "The amount discounted related to the billing period"
              }
              billingPeriodInMonth: {
                type: "integer"
                format: "int32"
                description: "Can be null. The billing period in month based on /billingPeriods"
              }
              billingPeriodPercentDiscount: {
                type: "number"
                format: "double"
                description: "The discount percent related to the billing period"
              }
            }
          }
          contractBonusInfo: {
            type: "object"
            description: "Describe the bonus information related to your current contract."
            required: ["bonuses"]
            properties: {
              bonuses: {
                type: "array"
                items: {
                  type: "object"
                  required: ["bonusType", "amount"]
                  properties: {
                    amount: {
                      type: "number"
                      format: "double"
                    }
                    bonusType: {
                      type: "string"
                      enum: ["OnlinePaymentMethodBonus", "PreviousInvoiceProrataBonus", "PreviousContractBonus"]
                    }
                  }
                }
              }
            }
          }
          contractClickInfo: {
            type: "object"
            description: "Describe the click information related to the offer."
            properties: {
              additionalClickPrice: {
                type: "number"
                format: "double"
                description: "The addition click price in the offer"
              }
              clickIncluded: {
                type: "integer"
                format: "int32"
                description: "The click included in the offer"
              }
              initialOfferClickIncluded: {
                type: "integer"
                format: "int32"
                description: "The click included in your current contract"
              }
            }
          }
          contractCommitmentInfo: {
            type: "object"
            description: "Describe the commitment information related to the offer."
            properties: {
              commercialCreatorUserId: {
                type: "string"
                format: "guid"
                description: "The commercial that is responsible of the creation of your account"
              }
              commercialUserId: {
                type: "string"
                format: "guid"
                description: "Your current commercial user id"
              }
              commitmentCalculatedFinishDate: {
                type: "string"
                format: "date"
                description: "The commitment end date related to the offer"
              }
              commitmentPeriodInMonth: {
                type: "integer"
                format: "int32"
                description: "The commitment period in month related to the offer"
              }
              contractType: {
                type: "integer"
                format: "int32"
                description: "Internal usage: Old offer type. Your contract type"
              }
              couponOfferCode: {
                type: "string"
                format: "guid"
                description: "Your special coupon offer identifier"
              }
              currentContractId: {
                type: "string"
                format: "guid"
                description: "Your current contract id"
              }
              currentContractTerminationDate: {
                type: "string"
                format: "date"
                description: "The current contract termination date"
              }
              currentCustomerPaymentMethod: {
                type: "string"
                description: "Payment method"
                enum: ["Transfer", "Debit", "Paypal", "Check", "CreditNote", "Loss", "OnlinePayment"]
              }
              fixedAndVariableClickInfo: {
                type: "object"
                description: "Internal usage: Old offer type. Describe the fix and variable model information"
                required: ["clickIncludedAndAdditionalClickPrices"]
                properties: {
                  clickIncludedAndAdditionalClickPrices: {
                    type: "array"
                    items: {
                      type: "object"
                      properties: {
                        additionalClickPrice: {
                          type: "number"
                          format: "double"
                          description: "The additional click price"
                        }
                        clickIncluded: {
                          type: "integer"
                          format: "int32"
                          description: "The click included"
                        }
                      }
                    }
                  }
                }
              }
              isCustomerWantsToTerminateHisContract: {
                type: "boolean"
                description: "If true, this means you want to leave us and that's sad... :'-("
              }
              isModelMustBeTransmittedInNewContract: {
                type: "boolean"
                description: "Internal usage: Old offer type. Is the current contract model needs to be converted into a new contract type"
              }
              minBillingPeriodInMonths: {
                type: "integer"
                format: "int32"
                description: "The minimum billing period in month authorized for this offer."
              }
              model: {
                type: "string"
                description: "Interal usage: Old offer type. The model description"
              }
              newContractStartDate: {
                type: "string"
                format: "date-time"
                description: "The start date related to the offer"
              }
              offerId: {
                type: "integer"
                format: "int32"
                description: "The offer id based on /offers. Not a free offer of course."
              }
              offerName: {
                type: "string"
                description: "The offer Name"
              }
              paymentDelayInDays: {
                type: "integer"
                format: "int32"
                description: "The payment delay in days related to the offer"
              }
              paymentMethodAuthorized: {
                type: "string"
                description: "Payment method"
                enum: ["Transfer", "Debit", "Paypal", "Check", "CreditNote", "Loss", "OnlinePayment"]
              }
              requestedPaymentMethod: {
                type: "string"
                description: "Payment method"
                enum: ["Transfer", "Debit", "Paypal", "Check", "CreditNote", "Loss", "OnlinePayment"]
              }
              trialPeriodFinishDate: {
                type: "string"
                format: "date"
                description: "The trial period end date related to the offer"
              }
              trialPeriodInMonth: {
                type: "integer"
                format: "int32"
                description: "The trial period in month related to the offer"
              }
              variableModelInfo: {
                type: "object"
                description: "Internal usage: Old offer type. Describe the fix and variable model information"
                required: ["clickIncludedAndVariablePrices", "overflowClickCount", "overflowClickPrice"]
                properties: {
                  clickIncludedAndVariablePrices: {
                    type: "array"
                    description: "Click included with variable pricing information"
                    items: {
                      type: "object"
                      properties: {
                        clickIncluded: {
                          type: "integer"
                          format: "int32"
                          description: "Click included"
                        }
                        variablePrice: {
                          type: "number"
                          format: "double"
                          description: "The pricing applied for this range"
                        }
                      }
                    }
                  }
                  overflowClickCount: {
                    type: "integer"
                    format: "int32"
                    description: "The overflow click count"
                  }
                  overflowClickPrice: {
                    type: "number"
                    format: "double"
                    description: "The overflow click price"
                  }
                }
              }
            }
          }
          contractDiscountInfo: {
            type: "object"
            description: "Describe the discount information related to the offer."
            properties: {
              amountCodePromoDiscount: {
                type: "number"
                format: "double"
                description: "The discount amount"
              }
              amountCodePromoDiscountPerMonth: {
                type: "number"
                format: "double"
                description: "The amount discounted per month"
              }
              couponDiscountCode: {
                type: "string"
                description: "The discount code"
              }
              couponDiscountId: {
                type: "integer"
                format: "int32"
                description: "Internal use: The discount id"
              }
              customerHasActualDiscount: {
                type: "boolean"
                description: "Do you have currently a discount on your contract ?"
              }
              discountDurationInMonth: {
                type: "integer"
                format: "int32"
                description: "Duration of the discount in month"
              }
              isCouponDiscountLinkedToCouponOffer: {
                type: "boolean"
                description: "Is this discount is related to a coupon offer"
              }
              percentDiscount: {
                type: "number"
                format: "double"
                description: "Percentage of the discount"
              }
              promotionalCodeValidity: {
                type: "string"
                description: "Indicate the validaty of the discount"
                enum: ["None", "Valid", "Invalid", "ExpiredOrInactive"]
              }
            }
          }
          contractMoneyInfo: {
            type: "object"
            description: "Describe the pricing information related to the offer."
            properties: {
              amountExcludingTaxesAndExcludingCodePromoDiscountIncludingBillingPeriodDiscount: {
                type: "number"
                format: "double"
                description: "The amount excluding taxes and excluding code promo discount including billing period discount."
              }
              amountExcludingTaxesAndExcludingDiscounts: {
                type: "number"
                format: "double"
                description: "The amount excluding taxes and excluding discounts."
              }
              amountExcludingTaxesIncludingDiscounts: {
                type: "number"
                format: "double"
                description: "The amount excluding taxes including discounts."
              }
              amountExcludingTaxesIncludingDiscountsPerMonth: {
                type: "number"
                format: "double"
                description: "The amount excluding taxes including discounts per month."
              }
              amountIncludingTaxesExcludingDiscountIncludingBillingPeriodDiscount: {
                type: "number"
                format: "double"
                description: "The amount including taxes excluding discount including billing period discount."
              }
              amountIncludingTaxesIncludingDiscounts: {
                type: "number"
                format: "double"
                description: "The amount including taxes including discounts."
              }
              amountTaxesExcludingDiscountIncludingBillingPeriodDiscount: {
                type: "number"
                format: "double"
                description: "The taxes excluding discount including billing period discount."
              }
              amountTaxesIncludingDiscounts: {
                type: "number"
                format: "double"
                description: "Taxes including discounts."
              }
              currencyCode: {
                type: "string"
                description: "The currency code <a href=\"https://en.wikipedia.org/wiki/ISO_4217\">(ISO 4217)</a>\n"
              }
              initialOfferFixedPrice: {
                type: "number"
                format: "double"
                description: "The initial offer fixed price."
              }
              vatPercent: {
                type: "number"
                format: "double"
                description: "The VAT percent."
              }
            }
          }
          contractStoreInfo: {
            type: "object"
            description: "Describe the store information related to the offer."
            properties: {
              additionalStorePrice: {
                type: "number"
                format: "double"
                description: "The additional store price."
              }
              maxStoreCount: {
                type: "integer"
                format: "int32"
                description: "The maximum store count related to the offer."
              }
              minStoreCount: {
                type: "integer"
                format: "int32"
                description: "The minimum store count related to the offer."
              }
              ownedStoreCount: {
                type: "integer"
                format: "int32"
                description: "The owned store count."
              }
              storeCount: {
                type: "integer"
                format: "int32"
                description: "The store count you want to have in your contract."
              }
              storeIncluded: {
                type: "integer"
                format: "int32"
                description: "The store count included in the offer."
              }
            }
          }
          contractTerminationReason: {
            type: "string"
            description: "The termination reason, if your current contract is scheduled to be terminated."
          }
          contractTerminationReasonType: {
            type: "integer"
            format: "int32"
            description: "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"
          }
          notifyVatExemption: {
            type: "boolean"
            description: "Internal usage: Indicates if we have to notify you about VAT exemption."
          }
          previousFixPeriodInvoiceProrataInfo: {
            type: "object"
            description: "Describe the prorata info based on your previous invoice"
            properties: {
              amountAfterTax: {
                type: "number"
                format: "double"
                description: "The amout after tax of the previous invoice"
              }
              amountToBePaid: {
                type: "number"
                format: "double"
                description: "The amount to be payed of the previous invoice"
              }
              computedProrataToBeDeducted: {
                type: "number"
                format: "double"
                description: "The prorata amount"
              }
              contractId: {
                type: "string"
                format: "guid"
                description: "The contract id related to the previous invoice"
              }
              fixedPeriodEndDate: {
                type: "string"
                format: "date"
                description: "The fixed end period of the previous invoice"
              }
              fixedPeriodStartDate: {
                type: "string"
                format: "date"
                description: "The fixed start period of the previous invoice"
              }
              invoiceNumber: {
                type: "string"
                description: "The previous invoice number"
              }
            }
          }
        }
      }
      info: {
        type: "object"
        properties: {
          errors: {
            type: "array"
            items: {
              type: "object"
              properties: {
                errorArguments: {
                  type: "object"
                }
                errorCode: {
                  type: "string"
                }
                errorGuid: {
                  type: "string"
                  format: "uuid"
                }
                errorMessage: {
                  type: "string"
                }
                exceptionDetail: {
                  type: "object"
                  properties: {
                    helpLink: {
                      type: "string"
                    }
                    message: {
                      type: "string"
                    }
                    stackTrace: {
                      type: "string"
                    }
                    type: {
                      type: "string"
                    }
                  }
                }
                objectName: {
                  type: "string"
                }
                propertyName: {
                  type: "string"
                }
                propertyValue: {
                  type: "string"
                }
                source: {
                  type: "string"
                }
                technicalErrorMessage: {
                  type: "string"
                }
                utcDate: {
                  type: "string"
                  format: "date-time"
                }
              }
            }
          }
          informations: {
            type: "array"
            items: {
              type: "object"
              properties: {
                informationArguments: {
                  type: "object"
                }
                informationCode: {
                  type: "string"
                }
                informationMessage: {
                  type: "string"
                }
                objectName: {
                  type: "string"
                }
                propertyName: {
                  type: "string"
                }
                propertyValue: {
                  type: "string"
                }
              }
            }
          }
          successes: {
            type: "array"
            items: {
              type: "object"
              properties: {
                objectName: {
                  type: "string"
                }
                propertyName: {
                  type: "string"
                }
                propertyValue: {
                  type: "string"
                }
                successArguments: {
                  type: "object"
                }
                successCode: {
                  type: "string"
                }
                successMessage: {
                  type: "string"
                }
              }
            }
          }
          warnings: {
            type: "array"
            items: {
              type: "object"
              properties: {
                technicalErrorMessage: {
                  type: "string"
                }
                warningArguments: {
                  type: "object"
                }
                warningCode: {
                  type: "string"
                }
                warningMessage: {
                  type: "string"
                }
              }
            }
          }
        }
      }
      links: {
        type: "object"
        description: "The different actions you can make on this offer"
        properties: {
          createContract: {
            type: "object"
          }
        }
      }
    }
  }
}