Get coupon association

Get a single coupon association by ID. Coupon associations are created and removed via the subscription modify API.

GET /coupons/associations/{id}

Get coupon association

cURL

curl --request GET \
  --url https://us.api.flexprice.io/v1/coupons/associations/{id} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://us.api.flexprice.io/v1/coupons/associations/{id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://us.api.flexprice.io/v1/coupons/associations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://us.api.flexprice.io/v1/coupons/associations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://us.api.flexprice.io/v1/coupons/associations/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://us.api.flexprice.io/v1/coupons/associations/{id}")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.api.flexprice.io/v1/coupons/associations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "coupon": {
    "amount_off": "<string>",
    "coupon_code": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "currency": "<string>",
    "duration_in_periods": 123,
    "environment_id": "<string>",
    "id": "<string>",
    "max_redemptions": 123,
    "metadata": {},
    "name": "<string>",
    "percentage_off": "<string>",
    "redeem_after": "<string>",
    "redeem_before": "<string>",
    "rules": {},
    "tenant_id": "<string>",
    "total_redemptions": 123,
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": "<string>"
  },
  "coupon_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "end_date": "2023-11-07T05:31:56Z",
  "environment_id": "<string>",
  "id": "<string>",
  "metadata": {},
  "start_date": "2023-11-07T05:31:56Z",
  "subscription_id": "<string>",
  "subscription_line_item_id": "<string>",
  "subscription_phase_id": "<string>",
  "tenant_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>"
}

{
  "http_status_code": 123,
  "message": "<string>"
}

{
  "http_status_code": 123,
  "message": "<string>"
}

Authorizations

x-api-key · string · header · required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

id · string · required

Coupon Association ID

Response

200

application/json

OK

coupon · object

Show child attributes

coupon_id · string

created_at · string<date-time>

created_by · string

end_date · string<date-time>

Optional

environment_id · string

id · string

metadata · object

Show child attributes

start_date · string<date-time>

status · enum<string>

Available options: published, deleted, archived

subscription_id · string

Mandatory

subscription_line_item_id · string

Optional

subscription_phase_id · string

Optional

tenant_id · string

updated_at · string<date-time>

updated_by · string