Skip to content

Get a coupon

GET
/coupons/{id}
curl --request GET \
--url https://api.proxyrequest.com/api/v1/coupons/example \
--header 'Authorization: Bearer <token>'

Returns one coupon visible within the caller’s account scope.

id
required
string

A unique value identifying this Coupon.

The operation completed successfully.

Media typeapplication/json
object
id
string
<= 36 characters
is_expired
required
boolean
is_redeemed
required
boolean
packages
required
Array<object>
object
key
additional properties
created
required
string format: date-time
value
required

Arbitrary coupon value

integer format: int64
>= -9223372036854776000 <= 9223372036854776000
code
required

Leaving this field empty will generate a random code.

string
is_multi_use
Multi-use

If true, coupon can be used multiple times.

boolean
is_available_to_one_time
Available for One-Time Purchases

If true, coupon can not be used for one-time package tiers.

boolean
type
required
  • free_data - Free Data * monetary - Money * percentage - Percentage
string
Allowed values: free_data monetary percentage
limit

Number of times coupon can be used

integer
>= -2147483648 <= 2147483647
valid_until

Leave empty for coupons that never expire

string format: date-time
nullable
marketer

The marketer who owns this coupon. Required if is_marketer is true.

string format: uuid
nullable
user
required

The user who created this coupon.

string format: uuid
nullable
Examples
Exampleexample

Example response

{
"id": "550e8400-e29b-41d4-a716-446655440001",
"is_expired": true,
"is_redeemed": true,
"packages": [
{}
],
"created": "2026-07-01T12:30:00Z",
"value": 1,
"code": "us",
"is_multi_use": true,
"is_available_to_one_time": true,
"type": "free_data",
"limit": 100,
"valid_until": "2026-07-01T12:30:00Z",
"marketer": "550e8400-e29b-41d4-a716-446655440001",
"user": "550e8400-e29b-41d4-a716-446655440001"
}

The request is malformed or violates a business rule.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
Exampleexample

Validation error

{
"non_field_errors": [
"The request could not be processed."
],
"translation": "errors.request.invalid"
}

Authentication credentials are missing, expired, or invalid.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExampleAuthenticationRequired

Authentication required

{
"detail": "Authentication credentials were not provided."
}

The authenticated account cannot perform this operation.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExamplePermissionDenied

Permission denied

{
"detail": "You do not have permission to perform this action."
}

The requested resource does not exist in the current account scope.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExampleResourceNotFound

Resource not found

{
"detail": "Not found."
}