Billing API

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Apikey, followed by the user's API Key.
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With the following properties:

  • annual_balance ⁠number
    amount of purchased over the past 12 months since the request
  • grid ⁠string
    price rate that is applied depending on the amount purchased over the last 12 months
  • outstanding_amount ⁠number
    amount of outstanding orders (payment by terms) since the last invoice

  Optional

  • prepaid ⁠object
    prepaid account information

    With the following properties:

    • amount ⁠number
      current amount available in the prepaid account
    • created_at ⁠datetime
      creation date of the prepaid account
    • currency ⁠string
      currency in use for the prepaid account
    • updated_at ⁠datetime
      last modification date of the prepaid account
    • warning_threshold ⁠number
      amount under which a warning email is sent
  • prepaid_monthly_invoice ⁠boolean
    indicates if orders are gathered into a single monthly invoice
  Example:

  {
    "prepaid": {
      "amount": 49856.3,
      "currency": "EUR",
      "warning_threshold": 100,
      "created_at": "2019-01-15T12:11:35Z",
      "updated_at": "2019-03-08T15:14:53Z"
    },
    "outstanding_amount": 0,
    "annual_balance": 120,
    "grid": "A"
  }

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • sharing_id ⁠string
    target organization id

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Apikey, followed by the user's API Key.
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With the following properties:

  • annual_balance ⁠number
    amount of purchased over the past 12 months since the request
  • grid ⁠string
    price rate that is applied depending on the amount purchased over the last 12 months
  • outstanding_amount ⁠number
    amount of outstanding orders (payment by terms) since the last invoice

  Optional

  • prepaid ⁠object
    prepaid account information

    With the following properties:

    • amount ⁠number
      current amount available in the prepaid account
    • created_at ⁠datetime
      creation date of the prepaid account
    • currency ⁠string
      currency in use for the prepaid account
    • updated_at ⁠datetime
      last modification date of the prepaid account
    • warning_threshold ⁠number
      amount under which a warning email is sent
  • prepaid_monthly_invoice ⁠boolean
    indicates if orders are gathered into a single monthly invoice
  Example:

  {
    "prepaid_monthly_invoice": false,
    "outstanding_amount": 0,
    "annual_balance": 250,
    "grid": "A"
  }

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string