Retrieve a redeemable token
GET https://api.ft.com/offers/{offerId}
For security reasons requests must be made over HTTPS.
| Path Param | Value |
|---|---|
| tokenId |
The unique identifier of the offer to be retrieved |
| Header | Value |
|---|---|
| X-Api-Key | <API key value> |
Not supported.
A JSON representation of the offer, an example of which is as below:
{
“offer”:
{
“id”: “41218b9e-c8ae-c934-43ad-71b13fcb4465”,
“name”: “FT.com Premium - £1/$1/€1 Trial Offer”,
“href”: “/membership/offers/v1/41218b9e-c8ae-c934-43ad-71b13fcb4465”,
“type”: “Trial”,
“product”:
{
“name”: “Premium FT.com”,
“type”: “Digital”,
“code”: “P2”,
“products”: [“P2”]
},
“restrictions”:
{
“countries”: [ “AFG”, “ALB”, “DZA”, “WLF” ],
“billingFrequency”: [
{
“unit”: “month”,
“value”: 1,
“displayName”: “Monthly”,
“iso8601Duration”: “P1M”
}],
“subscriptionTerms”: [
{
“displayName”: “Monthly”,
“iso8601Duration”: “P1M”
}]
},
“pricing”:
[
{
“country”: “AUS”,
“ratePlanId”: “2c92a0f94a37f8bb014a4e6caec20fe5”,
“currency”: “AUD”,
“charges”:
[
{
“id”: “2c92a0fb4a38064c014a4e6d9a74281a”,
“name”: “P2-Monthly-Trial”,
“basis”: “ONE_TIME”,
“amount”:
{
“currency”: “AUD”,
“value”: “1.00”,
“symbol”: “AU$”,
“nativeSymbol”: “$”
}
},
{
“id”: “2c92a0f94a37f8bb014a4e6fe3e828d5”,
“name”: “P2-Monthly-A97”,
“basis”: “RECURRING”,
“paymentDue”:
{
“after”: “P4W”
},
“billingFrequency”:
{
“unit”: “month”,
“value”: 1,
“displayName”: “Monthly”,
“iso8601Duration”: “P1M”
},
“subscriptionTerm”:
{
“displayName”: “Monthly”,
“iso8601Duration”: “P1M”
},
“type”: “Digital”,
“productCode”: “P2”,
“amount”: {
“currency”: “AUD”,
“value”: “61.00”,
“symbol”: “AU$”,
“nativeSymbol”: “$”
}
}
],
“total”:
{
“currency”: “AUD”,
“value”: “61.00”,
“symbol”: “AU$”,
“nativeSymbol”: “$”
}
} ]
}
}
| Http Status | Description |
|---|---|
| 200 Ok | The offer resource for the supplied offerId was returned successfully. |
| 403 Forbidden | Invalid API key |
| 404 Not Found | offer with that id was not found |
| 500 Error | Error |