> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Luma: Get V1 Calendars Coupons List
> List all coupons that have been created for a calendar. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.
List all coupons that have been created for a calendar.
Tool ID: `luma_get_v1_calendars_coupons_list`
## Run this action
Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.
```ts theme={null}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'luma_get_v1_calendars_coupons_list',
{
"pagination_cursor": "cursor_123",
"pagination_limit": 123
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute luma_get_v1_calendars_coupons_list --input '{
"pagination_cursor": "cursor_123",
"pagination_limit": 123
}' --json
```
## Example response
The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.
```json theme={null}
{
"data": {
"entries": [
{
"id": "id_123",
"code": "example",
"remaining_count": 123,
"valid_start_at": "2026-01-15T12:00:00Z",
"valid_end_at": "2026-01-15T12:00:00Z",
"percent_off": 1,
"cents_off": 1,
"currency": "solana_sol"
}
],
"has_more": true
}
}
```
Use `deepline tools get luma_get_v1_calendars_coupons_list --json` for the latest machine-readable contract.
## Input reference
List all coupons that have been created for a calendar.
| Name | Type | Required | Default | Details |
| --------------------------- | -------- | -------- | ------- | ------------------------------------------------------------------------ |
| `payload.pagination_cursor` | `string` | No | — | Value of `next_cursor` from a previous request. |
| `payload.pagination_limit` | `number` | No | — | The number of items to return. The server will enforce a maximum number. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "List all coupons that have been created for a calendar.",
"properties": {
"pagination_cursor": {
"type": "string",
"description": "Value of `next_cursor` from a previous request."
},
"pagination_limit": {
"type": "number",
"description": "The number of items to return. The server will enforce a maximum number."
}
},
"required": [],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.entries` | `array` | Yes | — | — |
| `result.data.entries[].id` | `string` | Yes | — | — |
| `result.data.entries[].code` | `string` | Yes | — | This code is case insensitive. |
| `result.data.entries[].remaining_count` | `integer` | Yes | — | Minimum: -9007199254740991. Maximum: 9007199254740991. |
| `result.data.entries[].valid_start_at` | `string \| null` | Yes | — | ISO 8601 Datetime. For example, 2022-10-19T03:27:13.673Z Format: `date-time`. |
| `result.data.entries[].valid_end_at` | `string \| null` | Yes | — | ISO 8601 Datetime. For example, 2022-10-19T03:27:13.673Z Format: `date-time`. |
| `result.data.entries[].percent_off` | `number \| null` | Yes | — | — |
| `result.data.entries[].cents_off` | `number \| null` | Yes | — | — |
| `result.data.entries[].currency` | `"solana_sol" \| "solana_usdc" \| "aed" \| "afn" \| "all" \| "amd" \| "ang" \| "aoa" \| "ars" \| "aud" \| "awg" \| "azn" \| "bam" \| "bbd" \| "bdt" \| "bgn" \| "bhd" \| "bif" \| "bmd" \| "bnd" \| "bob" \| "brl" \| "bsd" \| "bwp" \| "byn" \| "bzd" \| "cad" \| "cdf" \| "chf" \| "clp" \| "cny" \| "cop" \| "crc" \| "cve" \| "czk" \| "djf" \| "dkk" \| "dop" \| "dzd" \| "egp" \| "etb" \| "eur" \| "fjd" \| "fkp" \| "gbp" \| "gel" \| "ghs" \| "gip" \| "gmd" \| "gnf" \| "gtq" \| "gyd" \| "hkd" \| "hnl" \| "htg" \| "huf" \| "idr" \| "ils" \| "inr" \| "isk" \| "jmd" \| "jod" \| "jpy" \| "kes" \| "kgs" \| "khr" \| "kmf" \| "krw" \| "kwd" \| "kyd" \| "kzt" \| "lak" \| "lbp" \| "lkr" \| "lrd" \| "lsl" \| "mad" \| "mdl" \| "mga" \| "mkd" \| "mmk" \| "mnt" \| "mop" \| "mur" \| "mvr" \| "mwk" \| "mxn" \| "myr" \| "mzn" \| "nad" \| "ngn" \| "nio" \| "nok" \| "npr" \| "nzd" \| "omr" \| "pab" \| "pen" \| "pgk" \| "php" \| "pkr" \| "pln" \| "pyg" \| "qar" \| "ron" \| "rsd" \| "rub" \| "rwf" \| "sar" \| "sbd" \| "scr" \| "sek" \| "sgd" \| "shp" \| "sle" \| "sos" \| "srd" \| "std" \| "szl" \| "thb" \| "tjs" \| "tnd" \| "top" \| "try" \| "ttd" \| "twd" \| "tzs" \| "uah" \| "ugx" \| "usd" \| "uyu" \| "uzs" \| "vnd" \| "vuv" \| "wst" \| "xaf" \| "xcd" \| "xof" \| "xpf" \| "yer" \| "zar" \| "zmw"` | Yes | — | Allowed: `solana_sol`, `solana_usdc`, `aed`, `afn`, `all`, `amd`, `ang`, `aoa`, `ars`, `aud`, `awg`, `azn`, `bam`, `bbd`, `bdt`, `bgn`, `bhd`, `bif`, `bmd`, `bnd`, `bob`, `brl`, `bsd`, `bwp`, `byn`, `bzd`, `cad`, `cdf`, `chf`, `clp`, `cny`, `cop`, `crc`, `cve`, `czk`, `djf`, `dkk`, `dop`, `dzd`, `egp`, `etb`, `eur`, `fjd`, `fkp`, `gbp`, `gel`, `ghs`, `gip`, `gmd`, `gnf`, `gtq`, `gyd`, `hkd`, `hnl`, `htg`, `huf`, `idr`, `ils`, `inr`, `isk`, `jmd`, `jod`, `jpy`, `kes`, `kgs`, `khr`, `kmf`, `krw`, See the live schema for the complete constraint. |
| `result.data.entries[].event_ticket_type_id` | `string \| null` | No | — | The ticket type this coupon is restricted to, if any. Set for unlock (access) codes that reveal a hidden ticket type. |
| `result.data.has_more` | `boolean` | Yes | — | — |
| `result.data.next_cursor` | `string` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"entries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string",
"description": "This code is case insensitive."
},
"remaining_count": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"valid_start_at": {
"type": [
"string",
"null"
],
"description": "ISO 8601 Datetime. For example, 2022-10-19T03:27:13.673Z",
"format": "date-time"
},
"valid_end_at": {
"type": [
"string",
"null"
],
"description": "ISO 8601 Datetime. For example, 2022-10-19T03:27:13.673Z",
"format": "date-time"
},
"percent_off": {
"type": [
"number",
"null"
]
},
"cents_off": {
"type": [
"number",
"null"
]
},
"currency": {
"type": [
"string",
"null"
],
"enum": [
"solana_sol",
"solana_usdc",
"aed",
"afn",
"all",
"amd",
"ang",
"aoa",
"ars",
"aud",
"awg",
"azn",
"bam",
"bbd",
"bdt",
"bgn",
"bhd",
"bif",
"bmd",
"bnd",
"bob",
"brl",
"bsd",
"bwp",
"byn",
"bzd",
"cad",
"cdf",
"chf",
"clp",
"cny",
"cop",
"crc",
"cve",
"czk",
"djf",
"dkk",
"dop",
"dzd",
"egp",
"etb",
"eur",
"fjd",
"fkp",
"gbp",
"gel",
"ghs",
"gip",
"gmd",
"gnf",
"gtq",
"gyd",
"hkd",
"hnl",
"htg",
"huf",
"idr",
"ils",
"inr",
"isk",
"jmd",
"jod",
"jpy",
"kes",
"kgs",
"khr",
"kmf",
"krw",
"kwd",
"kyd",
"kzt",
"lak",
"lbp",
"lkr",
"lrd",
"lsl",
"mad",
"mdl",
"mga",
"mkd",
"mmk",
"mnt",
"mop",
"mur",
"mvr",
"mwk",
"mxn",
"myr",
"mzn",
"nad",
"ngn",
"nio",
"nok",
"npr",
"nzd",
"omr",
"pab",
"pen",
"pgk",
"php",
"pkr",
"pln",
"pyg",
"qar",
"ron",
"rsd",
"rub",
"rwf",
"sar",
"sbd",
"scr",
"sek",
"sgd",
"shp",
"sle",
"sos",
"srd",
"std",
"szl",
"thb",
"tjs",
"tnd",
"top",
"try",
"ttd",
"twd",
"tzs",
"uah",
"ugx",
"usd",
"uyu",
"uzs",
"vnd",
"vuv",
"wst",
"xaf",
"xcd",
"xof",
"xpf",
"yer",
"zar",
"zmw"
]
},
"event_ticket_type_id": {
"type": [
"string",
"null"
],
"description": "The ticket type this coupon is restricted to, if any. Set for unlock (access) codes that reveal a hidden ticket type."
}
},
"required": [
"id",
"code",
"remaining_count",
"valid_start_at",
"valid_end_at",
"percent_off",
"cents_off",
"currency"
],
"additionalProperties": false
}
},
"has_more": {
"type": "boolean"
},
"next_cursor": {
"type": "string"
}
},
"required": [
"entries",
"has_more"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Deepline cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
## Related documentation
* [Luma provider guide](/docs/providers/luma/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)