Apply a coupon to a customer
curl --request POST \
--url https://core.nozle.app/api/v1/applied_coupons \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"applied_coupon": {
"external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"coupon_code": "startup_deal",
"frequency": "recurring",
"frequency_duration": 3,
"amount_cents": 2000,
"amount_currency": "EUR",
"percentage_rate": null
}
}
'import requests
url = "https://core.nozle.app/api/v1/applied_coupons"
payload = { "applied_coupon": {
"external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"coupon_code": "startup_deal",
"frequency": "recurring",
"frequency_duration": 3,
"amount_cents": 2000,
"amount_currency": "EUR",
"percentage_rate": None
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
applied_coupon: {
external_customer_id: '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba',
coupon_code: 'startup_deal',
frequency: 'recurring',
frequency_duration: 3,
amount_cents: 2000,
amount_currency: 'EUR',
percentage_rate: null
}
})
};
fetch('https://core.nozle.app/api/v1/applied_coupons', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://core.nozle.app/api/v1/applied_coupons"
payload := strings.NewReader("{\n \"applied_coupon\": {\n \"external_customer_id\": \"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba\",\n \"coupon_code\": \"startup_deal\",\n \"frequency\": \"recurring\",\n \"frequency_duration\": 3,\n \"amount_cents\": 2000,\n \"amount_currency\": \"EUR\",\n \"percentage_rate\": null\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://core.nozle.app/api/v1/applied_coupons")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"applied_coupon\": {\n \"external_customer_id\": \"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba\",\n \"coupon_code\": \"startup_deal\",\n \"frequency\": \"recurring\",\n \"frequency_duration\": 3,\n \"amount_cents\": 2000,\n \"amount_currency\": \"EUR\",\n \"percentage_rate\": null\n }\n}"
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://core.nozle.app/api/v1/applied_coupons",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'applied_coupon' => [
'external_customer_id' => '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba',
'coupon_code' => 'startup_deal',
'frequency' => 'recurring',
'frequency_duration' => 3,
'amount_cents' => 2000,
'amount_currency' => 'EUR',
'percentage_rate' => null
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://core.nozle.app/api/v1/applied_coupons")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"applied_coupon\": {\n \"external_customer_id\": \"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba\",\n \"coupon_code\": \"startup_deal\",\n \"frequency\": \"recurring\",\n \"frequency_duration\": 3,\n \"amount_cents\": 2000,\n \"amount_currency\": \"EUR\",\n \"percentage_rate\": null\n }\n}")
.asString();{
"applied_coupon": {
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"lago_coupon_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"coupon_code": "startup_deal",
"coupon_name": "Startup Deal",
"lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"status": "active",
"frequency": "recurring",
"created_at": "2022-04-29T08:59:51Z",
"coupon_status": "active",
"coupon_deleted_at": "2022-04-29T08:59:51Z",
"amount_cents": 2000,
"amount_cents_remaining": 50,
"amount_currency": "EUR",
"percentage_rate": null,
"frequency_duration": 3,
"frequency_duration_remaining": 1,
"expiration_at": "2022-04-29T08:59:51Z",
"terminated_at": "2022-04-29T08:59:51Z"
}
}{
"status": 400,
"error": "Bad request"
}{
"status": 401,
"error": "Unauthorized"
}{
"status": 404,
"error": "Not Found",
"code": "object_not_found"
}{
"status": 422,
"error": "Unprocessable entity",
"code": "validation_errors",
"error_details": {}
}Coupons
Apply a coupon to a customer
This endpoint is used to apply a specific coupon to a customer, before or during a subscription.
POST
/
applied_coupons
Apply a coupon to a customer
curl --request POST \
--url https://core.nozle.app/api/v1/applied_coupons \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"applied_coupon": {
"external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"coupon_code": "startup_deal",
"frequency": "recurring",
"frequency_duration": 3,
"amount_cents": 2000,
"amount_currency": "EUR",
"percentage_rate": null
}
}
'import requests
url = "https://core.nozle.app/api/v1/applied_coupons"
payload = { "applied_coupon": {
"external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"coupon_code": "startup_deal",
"frequency": "recurring",
"frequency_duration": 3,
"amount_cents": 2000,
"amount_currency": "EUR",
"percentage_rate": None
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
applied_coupon: {
external_customer_id: '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba',
coupon_code: 'startup_deal',
frequency: 'recurring',
frequency_duration: 3,
amount_cents: 2000,
amount_currency: 'EUR',
percentage_rate: null
}
})
};
fetch('https://core.nozle.app/api/v1/applied_coupons', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://core.nozle.app/api/v1/applied_coupons"
payload := strings.NewReader("{\n \"applied_coupon\": {\n \"external_customer_id\": \"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba\",\n \"coupon_code\": \"startup_deal\",\n \"frequency\": \"recurring\",\n \"frequency_duration\": 3,\n \"amount_cents\": 2000,\n \"amount_currency\": \"EUR\",\n \"percentage_rate\": null\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://core.nozle.app/api/v1/applied_coupons")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"applied_coupon\": {\n \"external_customer_id\": \"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba\",\n \"coupon_code\": \"startup_deal\",\n \"frequency\": \"recurring\",\n \"frequency_duration\": 3,\n \"amount_cents\": 2000,\n \"amount_currency\": \"EUR\",\n \"percentage_rate\": null\n }\n}"
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://core.nozle.app/api/v1/applied_coupons",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'applied_coupon' => [
'external_customer_id' => '5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba',
'coupon_code' => 'startup_deal',
'frequency' => 'recurring',
'frequency_duration' => 3,
'amount_cents' => 2000,
'amount_currency' => 'EUR',
'percentage_rate' => null
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://core.nozle.app/api/v1/applied_coupons")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"applied_coupon\": {\n \"external_customer_id\": \"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba\",\n \"coupon_code\": \"startup_deal\",\n \"frequency\": \"recurring\",\n \"frequency_duration\": 3,\n \"amount_cents\": 2000,\n \"amount_currency\": \"EUR\",\n \"percentage_rate\": null\n }\n}")
.asString();{
"applied_coupon": {
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"lago_coupon_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"coupon_code": "startup_deal",
"coupon_name": "Startup Deal",
"lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"status": "active",
"frequency": "recurring",
"created_at": "2022-04-29T08:59:51Z",
"coupon_status": "active",
"coupon_deleted_at": "2022-04-29T08:59:51Z",
"amount_cents": 2000,
"amount_cents_remaining": 50,
"amount_currency": "EUR",
"percentage_rate": null,
"frequency_duration": 3,
"frequency_duration_remaining": 1,
"expiration_at": "2022-04-29T08:59:51Z",
"terminated_at": "2022-04-29T08:59:51Z"
}
}{
"status": 400,
"error": "Bad request"
}{
"status": 401,
"error": "Unauthorized"
}{
"status": 404,
"error": "Not Found",
"code": "object_not_found"
}{
"status": 422,
"error": "Unprocessable entity",
"code": "validation_errors",
"error_details": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Apply coupon payload
Show child attributes
Show child attributes
Response
Coupon applied
Show child attributes
Show child attributes