Comment on page
Create a price frequency tier
How to create a price frequency tier via API
To create a new price frequency tier, send a
POST
request to the /api/price_frequency_tiers
endpoint, passing the resource arguments in the request body.POST https://yourdomain.commercelayer.io/api/price_frequency_tiers
Body Parameter | Type | Required |
---|---|---|
type | string | Required |
attributes.name | string | Required |
attributes.up_to | integer | Optional |
attributes.price_amount_cents | integer | Required |
attributes.reference | string | Optional |
attributes.reference_origin | string | Optional |
attributes.metadata | object | Optional |
relationships.price | object | Required |
Request
Response
The following request creates a new price frequency tier:
curl -g -X POST \
'https://yourdomain.commercelayer.io/api/price_frequency_tiers' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "price_frequency_tiers",
"attributes": {
"name": "six pack",
"price_amount_cents": 1000
},
"relationships": {
"price": {
"data": {
"type": "prices",
"id": "ABCRtyUpBa"
}
}
}
}
}'
On success, the API responds with a
201 Created
status code, returning the created resource object:{
"data": {
"id": "xYZkjABcde",
"type": "price_frequency_tiers",
"links": {
"self": "https://yourdomain.commercelayer.io/api/price_frequency_tiers/xYZkjABcde"
},
"attributes": {
"name": "six pack",
"up_to": 7,
"price_amount_cents": 1000,
"price_amount_float": 10.0,
"formatted_price_amount": "€10,00",
"created_at": "2018-01-01T12:00:00.000Z",
"updated_at": "2018-01-01T12:00:00.000Z",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"metadata": {
"foo": "bar"
}
},
"relationships": {
"price": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/price_frequency_tiers/xYZkjABcde/relationships/price",
"related": "https://yourdomain.commercelayer.io/api/price_frequency_tiers/xYZkjABcde/price"
}
},
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/price_frequency_tiers/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/price_frequency_tiers/xYZkjABcde/attachments"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/price_frequency_tiers/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/price_frequency_tiers/xYZkjABcde/versions"
}
},
"events": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/price_frequency_tiers/xYZkjABcde/relationships/events",
"related": "https://yourdomain.commercelayer.io/api/price_frequency_tiers/xYZkjABcde/events"
}
}
},
"meta": {
"mode": "test"
}
}
}
Last modified 3mo ago