Billing

Returns account record based on X-SkySQL-Org-ID header value

get
Authorizations
X-API-KeystringRequired
Responses
chevron-right
200

OK

application/json
activebooleanOptional
legal_entity_identifierstringOptional
numberstringOptional
organization_idstringOptional
remittancebooleanOptional
scu_consumed_mtdnumberOptional
scu_remaining_mtdnumberOptional
start_datestringOptional
statusstringOptional
tierstringOptional
trial_creditnumberOptional
get
/billing/v1/account

Returns account record based on X-SkySQL-Org-ID header value

get
Authorizations
X-API-KeystringRequired
Responses
chevron-right
200

OK

application/json
contract_entitlement_idstringOptional
created_atstringOptional
idstringOptional
invoice_amountnumberOptional
min_compute_commitnumberOptional
org_idstringOptional
periodstringOptional
unused_compute_commitnumberOptional
get
/billing/v1/account/postpaid-commit-ledger

Returns account record based on X-SkySQL-Org-ID header value

get
Authorizations
X-API-KeystringRequired
Responses
chevron-right
200

OK

application/json
amountnumberOptional
batchintegerOptional
contract_idstringOptional
created_atstringOptional
idstringOptional
org_idstringOptional
reasonstringOptional
typestringOptional
get
/billing/v1/account/prepaid-credit-ledger

Returns usage allocation summary

get
Authorizations
X-API-KeystringRequired
Query parameters
yearstringOptional

billing year

monthstringOptional

billing month

Responses
chevron-right
200

OK

application/json
additional_compute_discountnumberOptional
billing_modestringOptional
currencystringOptional
currency_symbolstringOptional
data_transfer_costnumberOptional
discountnumberOptional
discounted_compute_costnumberOptional
idstringOptional
min_compute_costnumberOptional
org_idstringOptional
periodstringOptional
remaining_creditnumberOptional
support_costnumberOptional
support_typestringOptional
tierstringOptional
totalnumberOptional
total_compute_costnumberOptional
total_storage_costnumberOptional
undiscounted_compute_costnumberOptional
unused_compute_commitnumberOptional
unused_compute_commit_ledgernumberOptional
usage_daysintegerOptional
get
/billing/v1/bills

Returns organization contacts

get
Authorizations
X-API-KeystringRequired
Responses
chevron-right
200

OK

application/json
emailstringOptional
first_namestringOptional
idstringOptional
last_namestringOptional
phonestringOptional
typestringOptional
get
/billing/v1/contacts

Create organization contacts

post
Authorizations
X-API-KeystringRequired
Responses
chevron-right
200

OK

application/json
emailstringOptional
first_namestringOptional
idstringOptional
last_namestringOptional
phonestringOptional
typestringOptional
post
/billing/v1/contacts

Delete organization contacts

delete
Authorizations
X-API-KeystringRequired
Path parameters
contact_idstringRequired

Contact identifier

Responses
delete
/billing/v1/contacts/{contact_id}

No content

Update organization contacts

patch
Authorizations
X-API-KeystringRequired
Path parameters
contact_idstringRequired

Contact identifier

Responses
patch
/billing/v1/contacts/{contact_id}

No content

get
Authorizations
X-API-KeystringRequired
Responses
chevron-right
200

OK

application/json
billing_modestringOptional
created_atstringOptional
created_bystringOptional
currencystringOptional
end_datestringOptional
estimated_contract_commitnumberOptional
estimated_contract_valuenumberOptional
execution_datestringOptional
idstringOptional
integration_idstringOptional
marketing_collaboration_discountbooleanOptional
org_idstringOptional
renewal_datestringOptional
renewal_idstringOptional
start_datestringOptional
statestringOptional
updated_atstringOptional
updated_bystringOptional
get
/billing/v1/contracts/{org_id}

Returns list of invoices

get
Authorizations
X-API-KeystringRequired
Query parameters
start_datestringOptional

start date

Responses
chevron-right
200

OK

application/json
invoice_amountnumberOptional
invoice_datestringOptional
invoice_due_datestringOptional
invoice_idstringOptional
invoice_pdf_urlstringOptional
org_idstringOptional
periodstringOptional
get
/billing/v1/invoices

Returns list of invoices

get
Authorizations
X-API-KeystringRequired
Path parameters
invoice_idstringRequired

Invoice identifier

Query parameters
asstringOptional

resource or service

Responses
chevron-right
200

OK

application/json
bill_datestringOptional
currencystringOptional
invoice_amountnumberOptional
invoice_datestringOptional
invoice_due_datestringOptional
invoice_idstringOptional
invoice_pdf_urlstringOptional
org_idstringOptional
periodstringOptional
scu_consumednumberOptional
scu_remainingnumberOptional
statusstringOptional
symbolstringOptional
usage_end_datestringOptional
usage_start_datestringOptional
get
/billing/v1/invoices/{invoice_id}

Returns active countries

get
Authorizations
X-API-KeystringRequired
Query parameters
activebooleanOptional

true or false

Responses
chevron-right
200

OK

application/json
activebooleanOptional
iso3166_2stringOptional
iso3166_3stringOptional
leistringOptional
namestringOptional
vatbooleanOptional
get
/billing/v1/locale/country

Returns active states/provinces

get
Authorizations
X-API-KeystringRequired
Query parameters
activebooleanOptional

true or false

countrystringOptional

iso3166-2 country code

Responses
chevron-right
200

OK

application/json
activebooleanOptional
countrystringOptional
iso_shortstringOptional
namestringOptional
get
/billing/v1/locale/state-province
200

OK

Returns prices for different meters

get
Path parameters
offeringstringRequired

Offering identifier

Query parameters
providerstringOptional

provider name

productstringOptional

product name

topologystringOptional

topology name

tierstringOptional

tier name

Responses
chevron-right
200

OK

application/json
classstringOptional
descriptionstringOptional
labelstringOptional
meter_idstringOptional
namestringOptional
offering_idstringOptional
unitstringOptional
get
/billing/v1/meters/{id}

Returns prices for different meters

get
Path parameters
offeringstringRequired

Offering identifier

Query parameters
providerstringOptional

provider name

productstringOptional

product name

topologystringOptional

topology name

tierstringOptional

tier name

Responses
chevron-right
200

OK

application/json
descriptionstringOptional
namestringOptional
offering_idstringOptional
product_mappingstringOptional
get
/billing/v1/offerings

Returns prices for different meters

get
Path parameters
offeringstringRequired

Offering identifier

Query parameters
providerstringOptional

provider name

productstringOptional

product name

topologystringOptional

topology name

tierstringOptional

tier name

Responses
chevron-right
200

OK

application/json
classstringOptional
descriptionstringOptional
labelstringOptional
meter_idstringOptional
namestringOptional
offering_idstringOptional
unitstringOptional
get
/billing/v1/offerings/{id}/meters

Returns Payment Profile for request context OrgID

get
Responses
chevron-right
200

OK

application/json
default_payment_methodbooleanOptional
payment_method_idstringOptional
typestringOptional
get
/billing/v1/payment-methods

To setup payment method in Stripe

post
Authorizations
X-API-KeystringRequired
Responses
chevron-right
200

OK

application/json
intentstringOptional
keystringOptional
secretstringOptional
post
/billing/v1/payment-methods/setup-intent

Deleted payment method by id

delete
Path parameters
pm_idstringRequired

Payment identifier

Responses
delete
/billing/v1/payment-methods/{pm_id}

No content

Returns Payment Profile for request context OrgID

patch
Path parameters
pm_idstringRequired

Payment identifier

Responses
patch
/billing/v1/payment-methods/{pm_id}

No content

Returns prices for different meters

get
Path parameters
offeringstringRequired

Offering identifier

Query parameters
providerstringOptional

provider name

productstringOptional

product name

topologystringOptional

topology name

tierstringOptional

tier name

Responses
chevron-right
200

OK

application/json
end_rangenumberOptional
idstringOptional
start_rangenumberOptional
typestringOptional
get
/billing/v1/prices/{offering}

Returns organization tax information

get
Authorizations
X-API-KeystringRequired
Responses
chevron-right
200

OK

application/json
countrystringOptional
postal_codestringOptional
registrationstringOptional
get
/billing/v1/tax

Create organization tax information

post
Authorizations
X-API-KeystringRequired
Responses
chevron-right
200

OK

application/json
countrystringOptional
postal_codestringOptional
registrationstringOptional
post
/billing/v1/tax

Delete organization tax information

delete
Authorizations
X-API-KeystringRequired
Path parameters
tax_idstringRequired

Tax identifier

Responses
delete
/billing/v1/tax/{tax_id}

No content

Update organization tax information

patch
Authorizations
X-API-KeystringRequired
Path parameters
tax_idstringRequired

Tax identifier

Responses
patch
/billing/v1/tax/{tax_id}

No content

Returns usage allocation summary

get
Authorizations
X-API-KeystringRequired
Query parameters
yearstringOptional

billing year

monthstringOptional

billing month

Responses
chevron-right
200

OK

application/json
additional_compute_discountnumberOptional
billing_modestringOptional
currencystringOptional
currency_symbolstringOptional
data_transfer_costnumberOptional
discountnumberOptional
discounted_compute_costnumberOptional
idstringOptional
min_compute_costnumberOptional
org_idstringOptional
other_costnumberOptional
periodstringOptional
remaining_creditnumberOptional
support_costnumberOptional
support_typestringOptional
tierstringOptional
totalnumberOptional
total_compute_costnumberOptional
total_storage_costnumberOptional
undiscounted_compute_costnumberOptional
unused_compute_commitnumberOptional
usage_daysintegerOptional
get
/billing/v2/bills

Export invoice to PDF

get
Authorizations
X-API-KeystringRequired
Path parameters
invoice_idstringRequired

Invoice identifier

Responses
chevron-right
200

OK

application/pdf
integer[]Optional
get
/public/services/bcs/invoices/{invoice_id}/pdf

Last updated

Was this helpful?