Skip to main content
POST
/
connect
/
tariff
/
token
Create a connect token
curl --request POST \
  --url https://api.flatpeak.com/connect/tariff/token \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "direction": "IMPORT",
  "type": "COMMODITY",
  "callback_uri": "https://app.myapp.com/4623e56fc5c1",
  "connect_web_uri": "myapp://oauth-callback/flatpeak",
  "customer_id": "cus_65e421d1daa4a24082b4f590",
  "customer_reference_id": "CUS0123456789",
  "location_id": "loc_641b90b758fb8e6293716e40",
  "location_reference_id": "LOC0123456789",
  "tariff_id": "trf_6597ef46529ab4467502af0b",
  "postal_address": {
    "address_line1": "1-3",
    "address_line2": "Strand",
    "city": "London",
    "state": "Greater London",
    "post_code": "WC2N 5EH",
    "country_code": "GB"
  }
}'
{
  "connect_token": "cot_65df3e949a785c52283026ec",
  "expires_in": 86400,
  "live_mode": true
}
When you want to enable a customer to view the summary of their tariff anywhere in your app, update it or even revoke tariff access, specify a location_id in the request body. When you launch Connect, it will return the summary screen enabling tariff connection management.

Authorizations

​
Authorization
string
header
required

Body

application/json
​
callback_uri
string
required
Example:
​
direction
string
default:IMPORT
Example:
​
type
string
default:COMMODITY
Example:
​
connect_web_uri
string
Example:
​
customer_id
string
Example:
​
customer_reference_id
string
Example:
​
location_id
string
Example:
​
location_reference_id
string
Example:
​
tariff_id
string
Example:
​
postal_address
object

Response

​
connect_token
string
Example:
​
expires_in
integer
Example:
​
live_mode
boolean