Billing API

https://api.gandi.net/v5/billing

Gandi Billing API

/v5/billing/info

https://api.gandi.net/v5/billing/info

get Get your user account's information

Request

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

Responses

200

Body
  • application/json
    object

    With the following properties:

    • annual_balancenumber
      amount of purchased over the past 12 months since the request
    • gridstring
      price rate that is applied depending on the amount purchased over the last 12 months
    • outstanding_amountnumber
      amount of outstanding orders (payment by terms) since the last invoice
    Optional
    • prepaidobject
      prepaid account information

      With the following properties:

      • amountnumber
        current amount available in the prepaid account
      • created_atdatetime
        creation date of the prepaid account
      • currencystring
        currency in use for the prepaid account
      • updated_atdatetime
        last modification date of the prepaid account
      • warning_thresholdnumber
        amount under which a warning email is sent
    • prepaid_monthly_invoiceboolean
      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"
    }

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

Secured by

Authentication with API Key

This authentication scheme allows you to pass your Gandi API Key and be granted access to your resources, as your permissions allow.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

/v5/billing/info/{sharing_id}

https://api.gandi.net/v5/billing/info/{sharing_id}

get Get Account Information

Request

URI Parameters
    • sharing_idstring
      target organization id
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key

Responses

200

Body
  • application/json
    object

    With the following properties:

    • annual_balancenumber
      amount of purchased over the past 12 months since the request
    • gridstring
      price rate that is applied depending on the amount purchased over the last 12 months
    • outstanding_amountnumber
      amount of outstanding orders (payment by terms) since the last invoice
    Optional
    • prepaidobject
      prepaid account information

      With the following properties:

      • amountnumber
        current amount available in the prepaid account
      • created_atdatetime
        creation date of the prepaid account
      • currencystring
        currency in use for the prepaid account
      • updated_atdatetime
        last modification date of the prepaid account
      • warning_thresholdnumber
        amount under which a warning email is sent
    • prepaid_monthly_invoiceboolean
      indicates if orders are gathered into a single monthly invoice
    Example:
    {
      "prepaid_monthly_invoice": false,
      "outstanding_amount": 0,
      "annual_balance": 250,
      "grid": "A"
    }

403

Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

401

Bad authentication attempt because of a wrong API Key.
Body
  • application/json
    object

    With the following properties:

    • causestring
    • codeinteger
    • messagestring
    • objectstring

Secured by

Authentication with API Key

This authentication scheme allows you to pass your Gandi API Key and be granted access to your resources, as your permissions allow.
Headers
  • Required
    • Authorizationstring
      The Authorization header must start with Apikey, followed by the user's API Key.
      Example: Apikey your-api-key