---
title: "Get contract list"
method: GET
path: "/v2/user/customer/contracts"
tags: ["Customer - Contracts"]
---

# Get contract list

`GET /v2/user/customer/contracts`

## Headers

- `If-None-Match` string

## Response `200`

Contract list

- Contracts
  - `links` ContractsLinks, required
    - `self` LinksGetContractsLink
      - `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
    - `create` 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
  - `current` CurrentContractInfo — Get the conditions of your current contract
    - `trialPeriodInMonth` integer — The trial period in month
    - `billingPeriodPercentDiscount` number, double — The percent discount related to the billing period
    - `discountDurationInMonth` integer — The discount duration in month
    - `percentDiscount` number, double — The percent of the discount
    - `offerId` integer — The offer id based on /offers. Not a free offer of course.
    - `storeCount` integer — The store count you want to have in your contract.
    - `startUtcDate` string, date-time — The start date of your contract
    - `commitmentCalculatedFinishUtcDate` string, date-time — The calculated end date of commitment
    - `billingPeriodInMonth` integer — The billing period in month
    - `fixedPrice` number, double — The fixed price of your contract
    - `offerName` string — The offer name based on /offers
    - `currencyCode` string — The currency code <a href="https://en.wikipedia.org/wiki/ISO_4217">(ISO 4217)</a>
    - `contractId` string, guid — Your contract identifier
    - `commitmentPeriodInMonth` integer — The commitment period in month
    - `clickIncluded` integer — The click included
    - `additionalClickPrice` number, double — Additional click price
    - `ipUserCreation` string — The IP of the user who creates the contract
    - `ipUserModification` string — The IP of the user who modified the contract
    - `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
    - `isCommitmentRenewalAutomatically` boolean — Is commitment is automatically renewed
    - `discountEndUtcDate` string, date-time — The end of your discount
    - `isModifiableContract` boolean — Is the contract is modifiable ?
    - `links` CurrentContractInfoLinks, required
      - `disable` LinksTerminateCurrentContractLink
        - `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
              - …
            - `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
      - `reenable` LinksReactivateCurrentContractLink
        - `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
              - …
            - `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
  - `next` NextContractInfo — Get the conditions of your next contract
    - `trialPeriodInMonth` integer — The trial period in month
    - `billingPeriodPercentDiscount` number, double — The percent discount related to the billing period
    - `discountDurationInMonth` integer — The discount duration in month
    - `percentDiscount` number, double — The percent of the discount
    - `offerId` integer — The offer id based on /offers. Not a free offer of course.
    - `storeCount` integer — The store count you want to have in your contract.
    - `startUtcDate` string, date-time — The start date of your contract
    - `commitmentCalculatedFinishUtcDate` string, date-time — The calculated end date of commitment
    - `billingPeriodInMonth` integer — The billing period in month
    - `fixedPrice` number, double — The fixed price of your contract
    - `offerName` string — The offer name based on /offers
    - `currencyCode` string — The currency code <a href="https://en.wikipedia.org/wiki/ISO_4217">(ISO 4217)</a>
    - `contractId` string, guid — Your contract identifier
    - `commitmentPeriodInMonth` integer — The commitment period in month
    - `clickIncluded` integer — The click included
    - `additionalClickPrice` number, double — Additional click price
    - `ipUserCreation` string — The IP of the user who creates the contract
    - `ipUserModification` string — The IP of the user who modified the contract
    - `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
    - `isCommitmentRenewalAutomatically` boolean — Is commitment is automatically renewed
    - `discountEndUtcDate` string, date-time — The end of your discount
    - `isModifiableContract` boolean — Is the contract is modifiable ?
    - `links` NextContractInfoLinks, required
      - `delete` LinksDeleteNextContractLink
        - `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
              - …
            - `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

- `304` — The ETag sent in the http header If-None-Match did not change. So you are up to date !
- `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)