Billing API
https://api.gandi.net/v5/billing
/v5/billing/info ¶
https://api.gandi.net/v5/billing/info
get Get your user account's information ¶
Request
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Responses
200
Body
application/json
⁠objectWith the following properties:
- annual_balance ⁠numberamount of purchased over the past 12 months since the request
- grid ⁠stringprice rate that is applied depending on the amount purchased over the last 12 months
- outstanding_amount ⁠numberamount of outstanding orders (payment by terms) since the last invoice
Optional
- prepaid ⁠objectprepaid account information
With the following properties:
- amount ⁠numbercurrent amount available in the prepaid account
- created_at ⁠datetimecreation date of the prepaid account
- currency ⁠stringcurrency in use for the prepaid account
- updated_at ⁠datetimelast modification date of the prepaid account
- warning_threshold ⁠numberamount under which a warning email is sent
- amount ⁠number
- prepaid_monthly_invoice ⁠booleanindicates 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" }
- annual_balance ⁠number
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Authentication with API Key
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
/v5/billing/info/{sharing_id} ¶
https://api.gandi.net/v5/billing/info/{sharing_id}
get Get Account Information ¶
Request
URI Parameters
- sharing_id ⁠stringtarget organization id
- sharing_id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Responses
200
Body
application/json
⁠objectWith the following properties:
- annual_balance ⁠numberamount of purchased over the past 12 months since the request
- grid ⁠stringprice rate that is applied depending on the amount purchased over the last 12 months
- outstanding_amount ⁠numberamount of outstanding orders (payment by terms) since the last invoice
Optional
- prepaid ⁠objectprepaid account information
With the following properties:
- amount ⁠numbercurrent amount available in the prepaid account
- created_at ⁠datetimecreation date of the prepaid account
- currency ⁠stringcurrency in use for the prepaid account
- updated_at ⁠datetimelast modification date of the prepaid account
- warning_threshold ⁠numberamount under which a warning email is sent
- amount ⁠number
- prepaid_monthly_invoice ⁠booleanindicates if orders are gathered into a single monthly invoice
Example:{ "prepaid_monthly_invoice": false, "outstanding_amount": 0, "annual_balance": 250, "grid": "A" }
- annual_balance ⁠number
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Authentication with API Key
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
/v5/billing/price/{type} ¶
https://api.gandi.net/v5/billing/price/{type}
get Return product catalog prices. ¶
Request
URI Parameters
- type ⁠string
One of: "cloud", "domain", "domain_option", "issued-cert", "mailboxv2", "openstack", "phone_advisory", "simple-hosting", "tmch"
Minimum length: 1
- type ⁠string
Query String
Required
- name ⁠array
Of items of type:
- string
Minimum length: 1
- string
- processes ⁠array
Of items of type:
- string
Minimum length: 1
- string
Optional
- active_phase ⁠booleanactive phase
- country ⁠stringcountry
- currency ⁠stringcurrency
- discounts ⁠array
Of items of type:
- string
Minimum length: 1
- string
- duration_unit ⁠stringduration unit
- extension ⁠stringextension
- features ⁠booleanfeatures
- grid ⁠stringgrid
- lang ⁠stringlang
- max_duration ⁠integermax duration
- page ⁠integer
Default: 1
Minimum: 1
Which result page to retrieve. If the number is greater than the last page, an empty list is returned. - per_page ⁠integer
Minimum: 1
How many items to display per page. - prices_at ⁠datetimepricing date
- sharing_id ⁠stringsharing id
- name ⁠array
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Responses
200
Headers
- Total-Count ⁠integerTotal number of items.
Optional
- Link ⁠stringLinks to next and last page.
- Total-Count ⁠integer
Body
application/json
⁠objectWith the following properties:
- currency ⁠string
Minimum length: 1
- grid ⁠string
Minimum length: 1
- products ⁠array
Default: []
list of productsOf items of type:
- object
With the following properties:
- name ⁠string
Minimum length: 1
- phases ⁠array
Default: []
list of phasesOf items of type:
- object
With the following properties:
- name ⁠string
Minimum length: 1
name - starts_at ⁠datetimestart date of the phase
Optional
- ends_at ⁠datetimeend date of the phase
- name ⁠string
- object
- prices ⁠array
Default: []
list of pricesOf items of type:
- object
With the following properties:
- discount ⁠booleandiscount
- duration_unit ⁠string
Minimum length: 1
duration unit - features ⁠array
Default: []
Of items of type:
- object
With the following properties:
- name ⁠string
Minimum length: 1
name - name_label? ⁠string
Minimum length: 1
name label - type ⁠string
One of: "boolean", "string", "int", "float"
Minimum length: 1
type - value ⁠string
Minimum length: 1
value - value_label? ⁠string
Minimum length: 1
value label
- name ⁠string
- object
- max_duration ⁠integermax duration
- min_duration ⁠integermin duration
- options ⁠object
Default: {}
optionsWith the following properties:
Optional
- addresses ⁠stringcertificates details - addresses
- addresses_label ⁠stringcertificates details - addresses label
- commitment ⁠booleancommitment
- cores ⁠integeropenstack attributes - cores
- duration_change ⁠stringdomain attributes - duration change
- duration_change_label ⁠stringdomain attributes - duration change label
- extension ⁠stringextension related to a domain option
- force_registration_display ⁠booleandomain attributes - force registration display
- memory ⁠integeropenstack attributes - memory
- name_label ⁠stringopenstack attributes - name label
- offer ⁠stringcertificates attributes - offer
- offer_label ⁠stringcertificates attributes - offer label
- phase ⁠stringphase
- sgc ⁠booleancertificates details - sgc
- sgc_label ⁠stringcertificates details - sgc label
- size ⁠stringpass attributes - size
- size_label ⁠stringpass attributes - size label
- trial ⁠booleantrial
- value ⁠string
- warranty ⁠stringcertificates details - warranty
- warranty_label ⁠stringcertificates details - warranty label
- addresses ⁠string
- price_after_taxes ⁠numberprice after taxes
- price_before_taxes ⁠numberprice before taxes
Optional
- normal_price_after_taxes ⁠numbernormal price after taxes
- normal_price_before_taxes ⁠numbernormal price before taxes
- type ⁠string
- discount ⁠boolean
- object
- process ⁠stringprocess
- status ⁠string
Minimum length: 1
status - taxes ⁠array
Default: []
list of taxesOf items of type:
- object
With the following properties:
- name ⁠string
Minimum length: 1
- rate ⁠number
- type ⁠string
Minimum length: 1
Optional
- name_label ⁠string
- name ⁠string
- object
- name ⁠string
- object
- taxes ⁠arraylist of taxes
Of items of type:
- object
With the following properties:
- name ⁠string
Minimum length: 1
- rate ⁠number
- type ⁠string
Minimum length: 1
Optional
- name_label ⁠string
- name ⁠string
- object
Example:{ "currency": "EUR", "grid": "A", "taxes": [ { "name": "vat", "name_label": "VAT", "rate": 25, "type": "service" } ], "products": [ { "name": ".com", "phases": [], "prices": [ { "discount": false, "duration_unit": "y", "features": [], "max_duration": 2, "min_duration": 1, "options": { "phase": "golive" }, "price_before_taxes": 12.54, "price_after_taxes": 15.68 }, { "discount": false, "duration_unit": "y", "features": [], "max_duration": 10, "min_duration": 3, "options": { "phase": "golive" }, "price_before_taxes": 10.66, "price_after_taxes": 13.32 } ], "status": "available", "process": "create", "taxes": [ { "name": "vat", "name_label": "VAT", "rate": 25, "type": "service" } ] } ] }
- currency ⁠string
403
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Authentication with API Key
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string