Skip to main content
POST
(DEPRECATED) Approve or decline a purchase of a billing plan

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

purchase_proposal_id
string
required
Maximum string length: 512
Example:

"purchase.20rqjgFJf2O.ejl25"

Body

application/json

Payload to approve or decline a proposal

Approve or decline a proposal of a billing plan for an account

status
enum<string>
required
Available options:
APPROVE,
DECLINE

Response

Response to update proposal status request

Represents a Purchase

id
string
required
accountId
string
required
Minimum string length: 1
createdAt
string<date-time>
required
status
enum<string>
required

Status of the purchase

Available options:
SUCCESS,
FAILURE,
PENDING,
IN_PROGRESS,
PROPOSAL_ACTIVE,
PROPOSAL_APPROVED,
PROPOSAL_DECLINED,
PROPOSAL_EXPIRED
type
enum<string>
required

Specifies whether this purchase is for granting entitlements or for an association or for wallet topup or prepaid purchase. If left null, ENTITLEMENT_GRANT is taken as default

Available options:
ENTITLEMENT_GRANT,
ASSOCIATION,
WALLET_TOPUP,
PREPAID
paymentMode
enum<string>
required
Available options:
PREPAID,
POSTPAID
pricePlanId
string

Id of the price plan, Required for ENTITLEMENT_GRANT, ASSOCIATION purchase

Minimum string length: 1
quantity
integer<int32>
rateCardQuantities
object
idempotencyKey
string
pricePlanVersion
integer<int32>
purchasePlanOverride
object
associationOverride
object
walletTopupDetails
object

Information related to wallet topup purchase

updatedAt
string<date-time>
effectiveFrom
string<date>
effectiveUntil
string<date>
expiryDate
string<date-time>
price
number
invoiceId
string
invoiceCurrency
string
comment
string
proposalResponseDate
string<date-time>