Retrieve customer prepaid order details

1 min

GET

https://app.amberflo.io/payments/pricing/amberflo/customer-prepaid

Retrieves detailed information about a specific customer prepaid order including credit balance, usage restrictions, expiration dates, and transaction history.

Use this endpoint to:

Check specific prepaid order details and remaining balance
Review prepaid credit usage restrictions and conditions
Monitor prepaid order expiration dates and validity
Support customer service inquiries about prepaid purchases

customerIdstringUnique identifier of the customer whose prepaid order should be retrieved. Required unless RelationId is provided.

IdstringUnique identifier of the specific prepaid order to retrieve. Required unless RelationId is provided.

RelationIdstring<p>Base64-encoded serialized relationship identifier containing customer, prepaid, and product information. If provided, this parameter takes precedence over customerId, Id, and ProductId parameters.</p>

ProductIdstring<p>Unique identifier for the specific product associated with the prepaid order. If not provided, defaults to the account's default product ID.</p>

200Returns detailed prepaid order information including balance, usage restrictions, and expiration details

400Invalid customer ID, prepaid ID, or malformed request parameters

401Authentication required or invalid API key provided

403Insufficient permissions to access customer prepaid order details

404Customer or prepaid order not found

500Internal server error occurred while retrieving prepaid order details

curl --request GET \
     --url 'https://app.amberflo.io/payments/pricing/amberflo/customer-prepaid?customerId=customer_123&Id=prepaid_456' \
     --header 'accept: application/json'