Skip to main content
POST
Create trial link

Authorizations

Authorization
string
header
required

Link access token for one Sandbox, Test, or Live authorization.

x-linked-account-id
string
header
required

Selects one of the authorization's linked accounts via the x-linked-account-id header.

Headers

x-linked-account-id
string
required

The linked account to use. The user must have shared it with your app. A missing account returns linked_account_required; an account outside your access returns linked_account_not_granted.

Example:

"conn_example123"

Body

application/json
name
string
required

Trial link name

Required string length: 1 - 64
durationDays
enum<integer>
required

Trial duration in days. 30 means 1 month. Compact strings are accepted: 1m, 3m, 6m, 12m.

Available options:
1,
3,
7,
14,
30,
90,
180,
360
offer
object
required

Response

Successful response

id
number
required
url
string
required
subscribeDays
number
required
subscribeCounts
number
required
claimCounts
number
required
clicksCounts
number
required
expiredAt
string | null
required
createdAt
string
required
isFinished
boolean
required
user
object
sharedWith
object | null