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
#| Code | Status | What happened |
|---|---|---|
| invalid | 400 | An input is missing or invalid. |
| unauthenticated | 401 | The credential is missing, invalid, expired or revoked. |
| denied | 403 | The caller lacks permission for this action. |
| not_found | 404 | The resource is absent or inaccessible to this caller. |
| conflict | 409 | The request conflicts with the current resource state or an earlier request. |
| over_capacity | 409 | The request exceeds a resource or credential allowance. |
| access_list_full | 409 | The change would exceed the access-list allowance. |
| payment_required | 402 | Payment or credit is required. |
| rate_limited | 429 | The caller's request rate exceeds its limit. |
| busy | 429 | Too much work is in progress to accept this request. |
| unknown | 503 | The outcome is unconfirmed; a change may have happened. |
| unavailable | 503 | The service or requested feature is unavailable. |
Notes
#- API key permission:
billing redeem.