Account

Set this account's monthly spend cap

The cap bounds what you are billed past your plan's allowance, at your plan's own rate, over your Stripe billing period. The pages and images the plan includes never count toward it, so a cap of 0 means "never bill me past my plan" rather than "stop rendering". On an annual plan the figure is monthly and the period cap is twelve times it.

Anything from 0 to the maximum in max_self_serve_usd (also on GET /v1/account as limits.monthly_spend_cap_max_usd). Above that, write to support@galleyrender.com.

Free accounts and keyless trials cannot be billed and are never capped: the setting is stored and applies_now is false until the account is on a paid plan.

A rise is emailed to the account's verified address, because a key is the account and the inbox is the one place a key holder cannot reach.

post/v1/account/spend-cap

Request

  • Base URL: https://api.galleyrender.com
  • URL: https://api.galleyrender.com/v1/account/spend-cap
  • Auth: HTTP bearer

Request body

monthly_spend_cap_usdnumber required

US dollars a month, cents allowed. 0 means no overage at all.

Example request

{
  "monthly_spend_cap_usd": 100
}

Response

Set. In force from the next render on a paid plan.

object'spend_cap' required
accountstring required
planstring
monthly_spend_cap_usdnumber required
previous_monthly_spend_cap_usdnumber
period_spend_cap_usdnumber

What the cap is over the billing period: twelve times the monthly figure on an annual plan.

period_monthsinteger
max_self_serve_usdnumber
applies_nowboolean
effectstring
raise_above_the_maximumstring
docs_urlstring uri

Example response

{
  "monthly_spend_cap_usd": 100,
  "previous_monthly_spend_cap_usd": 50,
  "period_months": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.