PaymentLink
| Field | Type | Required | Description |
|---|---|---|---|
| amount | Money | ||
| amount_type | enum | Values: `fixed`, `open` | |
| code | string | ||
| collect_email | enum | Values: `required`, `optional`, `off` | |
| collect_name | enum | Values: `required`, `optional`, `off` | |
| collect_phone | enum | Values: `required`, `optional`, `off` | |
| created_at | string (date-time) | (date-time) | |
| currency | string | ||
| description | string | ||
| expires_at | string (date-time) | (date-time) | |
| id | string | ||
| max_amount | Money | ||
| max_uses | integer | ||
| metadata | object | ||
| min_amount | Money | ||
| mode | string | ||
| number | string | ||
| return_url | string | ||
| status | enum | Values: `active`, `disabled` | |
| uses | integer |
Example
Generated from the schema — a shape, not a sample.
{
"amount": {
"currency": "string",
"minor": 0
},
"amount_type": "fixed",
"code": "string",
"collect_email": "required",
"collect_name": "required",
"collect_phone": "required",
"created_at": "2026-10-01T09:00:00Z",
"currency": "string",
"description": "string",
"expires_at": "2026-10-01T09:00:00Z",
"id": "string",
"max_amount": {
"currency": "string",
"minor": 0
},
"max_uses": 0,
"metadata": {},
"min_amount": {
"currency": "string",
"minor": 0
},
"mode": "string",
"number": "string",
"return_url": "string",
"status": "active",
"uses": 0
}