v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB
Resource Rates

Retrieve the cancellation policy of a resource rate.

Returns the cancellation policy conditions that apply to the given resource rate, split into active-member and non-active-member condition sets. The consumer is responsible for selecting the applicable set.

Required scopes: flex.billing.cancellationPolicies.read

get/api/v2/organizations/{orgSlug}/resource-rates/{resourceRateId}/cancellation-policy

Path parameters

resourceRateIdstring required

resource rate id

orgSlugstring required

organization slug

Response

Example response

{
  "activeMemberConditions": [
    {
      "hours": 24,
      "cancellationFeePercent": 50
    },
    {
      "hours": 0,
      "cancellationFeePercent": 100
    }
  ],
  "nonActiveMemberConditions": [
    {
      "hours": 48,
      "cancellationFeePercent": 100
    }
  ]
}