Skip to main content
POST
/
applied_coupons
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request POST "$LAGO_URL/api/v1/applied_coupons" \
  --header "Authorization: Bearer $API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "applied_coupon": {
      "external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
      "coupon_code": "startup_deal",
      "amount_cents": 2500,
      "amount_currency": "EUR",
      "frequency": "recurring",
      "frequency_duration": 3
    }
  }'
from lago_python_client.client import Client
from lago_python_client.exceptions import LagoApiError
from lago_python_client.models import AppliedCoupon

client = Client(api_key='__YOUR_API_KEY__')

applied_coupon = AppliedCoupon(
  external_customer_id="5eb02857-a71e-4ea2-bcf9-57d8885990ba",
  coupon_code="startup_deal",
  amount_cents=2500,
  amount_currency="EUR",
  frequency="recurring",
  frequency_duration=3
)

try:
    client.applied_coupons.create(applied_coupon)
except LagoApiError as e:
    repair_broken_state(e)  # do something on error or raise your own exception
require 'lago-ruby-client'

client = Lago::Api::Client.new(api_key: '__YOUR_API_KEY__')

client.applied_coupons.create(
  external_customer_id: "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
  coupon_code: "startup_deal",
  amount_cents: 2500,
  amount_currency: "EUR",
  frequency: "recurring",
  frequency_duration: 3
)
const appliedCouponObject = {
  external_customer_id: "5eb02857-a71e-4ea2-bcf9-57d8885990ba",
  coupon_code: "startup_deal",
  amount_cents: 2500,
  amount_currency: "EUR",
  frequency: "recurring" as AppliedCouponObject["frequency"],
  frequency_duration: 3,
};

await client.appliedCoupons.applyCoupon({
  appliedCoupon: appliedCouponObject,
});
import "fmt"
import "github.com/getlago/lago-go-client"

func main() {
lagoClient := lago.New().
    SetApiKey("__YOUR_API_KEY__")

applyCouponInput := &lago.ApplyCouponInput{
    ExternalCustomerID: "5eb02857-a71e-4ea2-bcf9-57d8885990ba",
    CouponCode: "startup_deal",
    Frequency: lago.CouponFrequencyRecurring,
    FrequencyDuration: 3
}

appliedCoupon, err := lagoClient.Coupon().ApplyToCustomer(applyCouponInput)
if err != nil {
    // Error is *lago.Error
    panic(err)
}

// appliedCoupon is *lago.AppliedCoupon
fmt.Println(appliedCoupon)
}
{
  "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": {}
}
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request POST "$LAGO_URL/api/v1/applied_coupons" \
  --header "Authorization: Bearer $API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "applied_coupon": {
      "external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
      "coupon_code": "startup_deal",
      "amount_cents": 2500,
      "amount_currency": "EUR",
      "frequency": "recurring",
      "frequency_duration": 3
    }
  }'
from lago_python_client.client import Client
from lago_python_client.exceptions import LagoApiError
from lago_python_client.models import AppliedCoupon

client = Client(api_key='__YOUR_API_KEY__')

applied_coupon = AppliedCoupon(
  external_customer_id="5eb02857-a71e-4ea2-bcf9-57d8885990ba",
  coupon_code="startup_deal",
  amount_cents=2500,
  amount_currency="EUR",
  frequency="recurring",
  frequency_duration=3
)

try:
    client.applied_coupons.create(applied_coupon)
except LagoApiError as e:
    repair_broken_state(e)  # do something on error or raise your own exception
require 'lago-ruby-client'

client = Lago::Api::Client.new(api_key: '__YOUR_API_KEY__')

client.applied_coupons.create(
  external_customer_id: "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
  coupon_code: "startup_deal",
  amount_cents: 2500,
  amount_currency: "EUR",
  frequency: "recurring",
  frequency_duration: 3
)
const appliedCouponObject = {
  external_customer_id: "5eb02857-a71e-4ea2-bcf9-57d8885990ba",
  coupon_code: "startup_deal",
  amount_cents: 2500,
  amount_currency: "EUR",
  frequency: "recurring" as AppliedCouponObject["frequency"],
  frequency_duration: 3,
};

await client.appliedCoupons.applyCoupon({
  appliedCoupon: appliedCouponObject,
});
import "fmt"
import "github.com/getlago/lago-go-client"

func main() {
lagoClient := lago.New().
    SetApiKey("__YOUR_API_KEY__")

applyCouponInput := &lago.ApplyCouponInput{
    ExternalCustomerID: "5eb02857-a71e-4ea2-bcf9-57d8885990ba",
    CouponCode: "startup_deal",
    Frequency: lago.CouponFrequencyRecurring,
    FrequencyDuration: 3
}

appliedCoupon, err := lagoClient.Coupon().ApplyToCustomer(applyCouponInput)
if err != nil {
    // Error is *lago.Error
    panic(err)
}

// appliedCoupon is *lago.AppliedCoupon
fmt.Println(appliedCoupon)
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Apply coupon payload

applied_coupon
object
required

Response

Coupon applied

applied_coupon
object
required