Skip to main content
GET
/
api
/
v2
/
external-billing
/
payment-requests
/
{payment_request_id}
Get Payment Request
curl --request GET \
  --url https://api.voiceaiwrapper.app/api/v2/external-billing/payment-requests/{payment_request_id}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": "10",
  "client_id": "42",
  "client_name": "Acme Corp",
  "subscription_id": "1",
  "status": "PENDING",
  "type": "SUBSCRIPTION",
  "amount": "99.00",
  "currency": "USD",
  "due_date": "2025-01-15T00:00:00",
  "grace_period_ends_at": "2025-01-22T00:00:00",
  "paid_at": null,
  "external_payment_id": null,
  "notes": null,
  "line_items": [],
  "period_start": "2025-01-01T00:00:00",
  "period_end": "2025-02-01T00:00:00",
  "created_at": "2025-01-01T00:00:00",
  "updated_at": "2025-01-01T00:00:00"
}
This endpoint requires a PRO plan or above. If your plan does not include the External Billing API, the request returns 403 with error code external_billing_api.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
payment_request_id
string
required

Integer ID of the payment request.

Example:

"10"

Response

Payment request returned successfully.

​
id
string

Payment request ID.

Example:

"10"

​
client_id
string

ID of the client this payment request belongs to.

Example:

"42"

​
client_name
string

Display name of the client.

Example:

"Acme Corp"

​
subscription_id
string | null

ID of the associated subscription (null for non-subscription requests).

Example:

"1"

​
status
enum<string>

Current payment request status.

Available options:
PENDING,
PAID,
FAILED,
CANCELED,
OVERDUE
Example:

"PENDING"

​
type
enum<string>

Type of the payment request.

Available options:
SUBSCRIPTION,
ADDON,
OVERAGE,
ONE_TIME
Example:

"SUBSCRIPTION"

​
amount
string

Total amount as a decimal string.

Example:

"99.00"

​
currency
string

3-letter currency code.

Example:

"USD"

​
period_start
string<date-time> | null

Start of the billing period this request covers.

Example:

"2025-01-01T00:00:00"

​
period_end
string<date-time> | null

End of the billing period this request covers.

Example:

"2025-02-01T00:00:00"

​
due_date
string<date-time> | null

Date by which payment is due.

Example:

"2025-01-15T00:00:00"

​
grace_period_ends_at
string<date-time> | null

End of grace period (cycle requests only). Null for pack requests.

Example:

"2025-01-22T00:00:00"

​
paid_at
string<date-time> | null

Timestamp when the request was marked paid. Null if not yet paid.

Example:

null

​
external_payment_id
string | null

Optional external transaction reference (e.g. a payment processor transaction ID).

Example:

null

​
notes
string | null

Free-text notes on the request.

Example:

null

​
line_items
object[]

Breakdown of individual line items making up the total amount.

​
created_at
string<date-time>

When the request was created (ISO 8601).

Example:

"2025-01-01T00:00:00"

​
updated_at
string<date-time>

When the request was last updated (ISO 8601).

Example:

"2025-01-01T00:00:00"