Validate Client Package has redemption [Alpha]

Overview

Check whether the authenticated client has an active package with available credits for the service associated with a given payment status. Use this to determine if the "pay with package" option should be shown to the client before calling the update_usage endpoint.

Authentication

Available for Client Tokens only.

Required Parameters

• payment_status_id (query, string) — The ID of the payment status to check. Must reference a pending/unpaid payment status.

Response

• Returns has_package: true if a suitable active package with available credits exists for the service.
• Returns has_package: false if no suitable package is available.

Notes

• Returns 422 if the payment status is already paid.
• This endpoint is in Alpha and may change.