Skip to content

Redeem an offer

Apply an offer code to your account. Promotional credit enters the wallet immediately. A discount, trial or capacity boost applies to the next eligible purchase.

Parameters

#
codestringRequired
The offer code.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobjectAlways present
A redeemed offer.
Show 5 attributesHide attributes
credit_microsinteger
Promotional credit added to the wallet now, in millionths of a dollar. May be omitted.
effectstringAlways present
Benefit granted by the offer.
expires_atstring (date-time)
When the resulting credit expires, if it has an expiry. May be omitted.
offerstringAlways present
Offer that was redeemed.
waiting_for_purchasebooleanAlways present
Whether the offer is saved but waits for a qualifying purchase.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
payment_required402Payment or credit is required.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • API key permission: billing redeem.