Decline a purchase request

Before you call

Credential

Authorization: Bearer $KEY

Scope

voice:write

Graphql

Mutation.voicePhonePurchaseDecline

Sdk

voice.phonePurchase.decline

Cli

voice phone purchase decline

Parameters

• idstringrequired
  In the path

Responses

• 200application/json
  Success
  • idstringrequired
  • numberstringrequired
  • countrystringrequired
  • typestringrequired
  • labelstringrequired
  • quoteMicrosnumber or nullrequired
  • currencystringrequired
  • requirementslist of objectrequired
    • kindstringrequired
    • titlestringrequired
    • blocksPurchasebooleanrequired
  • statestringrequired
    One of: pending, confirmed, bought, declined, expired, failed.
  • requestedBystringrequired
  • decidedBystring or nullrequired
  • numberIdstring or nullrequired
  • notestringrequired
  • createdAtstringrequired
  • expiresAtstringrequired
• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring