rates_destinations
Creates, updates, deletes, gets or lists a rates_destinations resource.
Overview​
| Name | rates_destinations |
| Type | Resource |
| Id | ovh.sms.rates_destinations |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
country | string | The country full name |
country_code | string | The country 2-letters code (ad, ae, af, ag, ai, al, all, am, an, ao, ar, at, au, aw, az, ba, bb, bd, be, bf, bg, bh, bi, bj, bm, bn, bo, br, bs, bt, bw, by, bz, ca, cd, cf, cg, ch, ci, ck, cl, cm, cn, co, cr, cu, cv, cy, cz, de, dk, dm, dz, ec, ee, eg, es, et, fi, fj, fk, fo, fr, ga, gb, gd, ge, gf, gh, gi, gl, gm, gn, gp, gq, gr, gt, gu, gw, gy, hk, hn, hr, ht, hu, id, ie, il, in, io, iq, ir, is, it, jm, jo, jp, ke, kg, kh, km, kn, kr, kw, ky, kz, la, lb, lc, li, lk, lr, ls, lt, lu, lv, ly, ma, md, me, mg, mk, ml, mn, mo, mq, mr, ms, mt, mu, mv, mw, mx, my, mz, na, nc, ne, ng, ni, nl, no, np, nz, om, pa, pe, pf, pg, ph, pk, pl, ps, pt, py, qa, re, ro, rs, ru, rw, sa, sb, sc, sd, se, sg, si, sk, sl, sm, sn, so, sr, st, sv, sy, sz, tc, td, tg, th, tj, tl, tm, tn, to, tr, tt, tw, tz, ua, ug, us, uy, uz, vc, ve, vg, vi, vn, vu, ws, ye, yt, za, zm, zw) (wire: countryCode) |
credit | number | Credits consumed by sending one SMS towards the given destination |
price | object | Price of one SMS sent towards the given destination |
vat_rate | number | The VAT rate applied from the provided billing country. (wire: vatRate) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | country | billing_country | Get rates for a country. Returns the credits consumed and the price of one SMS sent to a country, for credits bought in the billing country, with the VAT rate. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
country | string | Country where you send SMS |
billing_country | string | Country where you buy credits (wire: billingCountry) |
SELECT examples​
- get
Get rates for a country. Returns the credits consumed and the price of one SMS sent to a country, for credits bought in the billing country, with the VAT rate.
SELECT
country,
country_code,
credit,
price,
vat_rate
FROM ovh.sms.rates_destinations
WHERE country = '{{ country }}' -- required
AND billing_country = '{{ billing_country }}'
;