Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-13121230447.8 KB
Accounts

Propose a purchase of a plan

This API let’s you to create a proposal of a billing/entitlement plan for an account

post/accounts/{account_id}/purchase_proposals

Path parameters

account_idstring required
Example:ACC00001

account_id corresponding to an account

Request body

pricePlanIdstring

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

quantityinteger
rateCardQuantitiesobject
idempotencyKeystring
effectiveFromstring date
effectiveUntilstring date
expiryDatestring date-time
type'ENTITLEMENT_GRANT' | 'ASSOCIATION' | 'WALLET_TOPUP' | 'PREPAID' 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

paymentMode'PREPAID' | 'POSTPAID' required

Response

Response to create proposal request

idstring required
accountIdstring required
pricePlanIdstring

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

quantityinteger
rateCardQuantitiesobject
idempotencyKeystring
pricePlanVersioninteger
createdAtstring date-time required
updatedAtstring date-time
effectiveFromstring date
effectiveUntilstring date
expiryDatestring date-time
pricenumber
invoiceIdstring
invoiceCurrencystring
status'SUCCESS' | 'FAILURE' | 'PENDING' | 'IN_PROGRESS' | 'PROPOSAL_ACTIVE' | 'PROPOSAL_APPROVED' | 'PROPOSAL_DECLINED' | 'PROPOSAL_EXPIRED' required

Status of the purchase

type'ENTITLEMENT_GRANT' | 'ASSOCIATION' | 'WALLET_TOPUP' | 'PREPAID' 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

commentstring
paymentMode'PREPAID' | 'POSTPAID' required
proposalResponseDatestring date-time