Get a customer's agreed rates
GET
/v1/organizations/{orgId}/rate-cardAuthorization
AuthorizationBasic auth · headerrequiredRegistered confidential integration credentials. Keep the secret server-side.
or
CookieAPI key · headerrequiredConsole-managed Vault session cookie; secure cookie naming may vary by environment.
or
AuthorizationBearer token (Vault organization API key) · headerrequiredOrganization-owned credential with immutable mode and Read-only or Read/write permissions. Only explicitly declared ordinary customer operations accept it. Test business access refuses until shared Test composition is available; no staff, team, key-management or protocol authority is granted.
Path parameters
orgIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Responses
200
Success
dataobjectrequiredShow propertiesHide properties
asOfstring<date>requiredmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
organizationIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
servicesobject[]requiredShow propertiesHide properties
Array of
objectcurrentRateobject | nullrequiredShow propertiesHide properties
Any of:
object
currencystringrequiredmatches ^[A-Z]{3}$
effectiveFromstring<date>requiredmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
parametersobjectrequiredShow propertiesHide properties
bundleQuantityintegermin 1 · max 9007199254740991
includedDaysintegermin 0 · max 9007199254740991
includedMinutesintegermin 0 · max 9007199254740991
includedQuantityintegermin 0 · max 9007199254740991
incrementMinutesintegermin 1 · max 9007199254740991
launchReservationCreditstringmax length 32 · matches ^(0|[1-9]\d*)(\.\d+)?$
measurementstringAllowed:
daily_observed_volumeperiod_quantityminimumEligiblebooleanminimumMinutesintegermin 1 · max 9007199254740991
overageRatestringmax length 32 · matches ^(0|[1-9]\d*)(\.\d+)?$
premiumPolicystringAllowed:
additive_allowedhighest_applicableroundingstringAllowed:
ceiling_per_itemhalf_up_oncesourceAdjustmentWindowDaysintegermin 0 · max 9007199254740991
volumeBandsobject[]min items 1 · max items 20
Show propertiesHide properties
Array of
objectfromQuantityintegerrequiredmin 0 · max 9007199254740991
ratestringrequiredmax length 32 · matches ^(0|[1-9]\d*)(\.\d+)?$
ratestringrequiredmax length 32 · matches ^(0|[1-9]\d*)(\.\d+)?$
null
nullcustomerDescriptionstring | nullrequireddisplayNamestringrequiredpricingBasisstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullquantityUnitstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullscheduledRatesobject[]requiredShow propertiesHide properties
Array of
objectcurrencystringrequiredmatches ^[A-Z]{3}$
effectiveFromstring<date>requiredmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
parametersobjectrequiredShow propertiesHide properties
bundleQuantityintegermin 1 · max 9007199254740991
includedDaysintegermin 0 · max 9007199254740991
includedMinutesintegermin 0 · max 9007199254740991
includedQuantityintegermin 0 · max 9007199254740991
incrementMinutesintegermin 1 · max 9007199254740991
launchReservationCreditstringmax length 32 · matches ^(0|[1-9]\d*)(\.\d+)?$
measurementstringAllowed:
daily_observed_volumeperiod_quantityminimumEligiblebooleanminimumMinutesintegermin 1 · max 9007199254740991
overageRatestringmax length 32 · matches ^(0|[1-9]\d*)(\.\d+)?$
premiumPolicystringAllowed:
additive_allowedhighest_applicableroundingstringAllowed:
ceiling_per_itemhalf_up_oncesourceAdjustmentWindowDaysintegermin 0 · max 9007199254740991
volumeBandsobject[]min items 1 · max items 20
Show propertiesHide properties
Array of
objectfromQuantityintegerrequiredmin 0 · max 9007199254740991
ratestringrequiredmax length 32 · matches ^(0|[1-9]\d*)(\.\d+)?$
ratestringrequiredmax length 32 · matches ^(0|[1-9]\d*)(\.\d+)?$
serviceCodestringrequiredmin length 1 · max length 64 · matches ^[a-z][a-z0-9_]*$
serviceIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
statusstringrequiredAllowed:
disabledenabledincludedmetaobjectrequiredShow propertiesHide properties
requestIdstringrequireddefault
Error
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_readyfieldsobject[]Show propertiesHide properties
Array of
objectcodestringrequiredmessagestringrequiredpathstringrequiredmessagestringrequiredoperationIdstringmetaobjectrequiredShow propertiesHide properties
requestIdstringrequired