> ## Documentation Index > Fetch the complete documentation index at: https://developers.papelship.com/llms.txt > Use this file to discover all available pages before exploring further. # List coupons > **Permission:** `coupons:read` ## OpenAPI ````yaml /api-reference/openapi/user-api.yaml get /coupons openapi: 3.0.3 info: title: PapelShip Store API version: 1.0.0 description: >- Manage your PapelShip store from your own systems: create orders, sync products and stock, ship physical orders, answer support tickets and react to events. Every request needs your API key in `x-api-key` and your store ID in `x-store-hash`. Amounts are integers in minor units (`2999` = 29.99). Dates are ISO 8601 in UTC. contact: name: PapelShip Support email: support@papelship.com url: https://papelship.com servers: - url: https://app.papelship.com/api/v1 description: Production security: - ApiKey: [] StoreHash: [] tags: - name: Account description: Your key, store and payment methods. - name: Orders description: Create orders, take manual payments, cancel, refund and read deliveries. - name: Products description: Products and their settings. - name: Variants & stock description: Variants, physical stock and license keys. - name: Product content description: Media, SEO, payment methods, files and stock alerts. - name: Categories description: Organise products. - name: Groups description: Collections of products. - name: Coupons description: Discount codes. - name: Customers description: Buyers and their history. - name: Blocklist description: Emails and IPs that can't place orders. - name: Reviews description: Customer reviews. - name: Support description: Support tickets. - name: Subscriptions description: Recurring products and auto-renewals. - name: Fulfillment description: Ship physical orders. - name: Returns description: Return requests. - name: Shipping settings description: Zones, rates and locations. - name: Webhooks description: Endpoints, deliveries and event types. - name: Affiliates description: Partner programme. - name: Analytics description: Sales summary. paths: /coupons: get: tags: - Coupons summary: List coupons description: '**Permission:** `coupons:read`' operationId: listCoupons parameters: - in: query name: q schema: type: string description: Search code or hash ID. - in: query name: status schema: type: string enum: - active - inactive - in: query name: limit schema: type: integer default: 25 minimum: 1 maximum: 100 description: Items per page (1–100). - in: query name: offset schema: type: integer default: 0 minimum: 0 description: Number of items to skip. responses: '200': description: A page of results content: application/json: schema: type: object properties: success: type: boolean example: true coupons: type: array items: $ref: '#/components/schemas/Coupon' pagination: $ref: '#/components/schemas/Pagination' required: - success '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/ValidationFailed' '429': $ref: '#/components/responses/RateLimited' components: schemas: Coupon: type: object properties: id: type: integer example: 35 object: type: string example: coupon hash_id: type: string example: XcLtb99X code: type: string example: SUMMER20 type: type: string enum: - percent - fixed example: percent value: type: integer description: Percent (1–100) or minor units for `fixed` (500 = 5.00). example: 20 max_uses: type: integer nullable: true used_count: type: integer example: 0 usage_count: type: integer example: 0 require_purchase: type: boolean example: false valid_from: type: string format: date-time nullable: true example: '2026-10-04T12:00:00.000Z' valid_to: type: string format: date-time nullable: true example: '2026-10-04T12:00:00.000Z' status: type: string enum: - active - inactive example: active product_count: type: integer example: 0 is_all_products: type: boolean description: '`true` when the coupon is not limited to products.' example: true disabled_payment_methods: type: array description: Methods the coupon can't be used with. example: [] items: type: string product_ids: type: array description: Detail responses only. items: type: integer products: type: array description: Detail responses only. items: $ref: '#/components/schemas/ProductRef' created_at: type: string format: date-time example: '2026-10-04T12:00:00.000Z' updated_at: type: string format: date-time example: '2026-10-04T12:00:00.000Z' Pagination: type: object properties: total: type: integer description: Total number of matching records. example: 128 limit: type: integer example: 25 offset: type: integer example: 0 has_more: type: boolean description: '`true` when another page exists.' example: true ProductRef: type: object properties: id: type: integer hash_id: type: string example: a1B2c3D4e5F6 name: type: string example: Pro License slug: type: string example: pro-license Error: type: object properties: success: type: boolean example: false code: type: string description: Machine-readable error code. Branch on this, not on the message. example: VALIDATION_FAILED error: type: string description: Human-readable message. example: customer_email must be a valid email address details: type: object properties: {} description: Extra context, for example `field` for validation errors. additionalProperties: true request_id: type: string description: Include this when you contact support. example: req_7YbK2mQ9xP1cRt4v required: - success - code - error responses: Unauthorized: description: >- Missing, invalid or expired API key. Codes: `MISSING_API_KEY`, `MISSING_STORE_HASH`, `INVALID_API_KEY`, `API_KEY_EXPIRED` content: application/json: schema: $ref: '#/components/schemas/Error' example: success: false code: INVALID_API_KEY error: Invalid API Key request_id: req_7YbK2mQ9xP1cRt4v Forbidden: description: >- The key is not allowed to do this. Codes: `INSUFFICIENT_SCOPE`, `IP_NOT_ALLOWED`, `STORE_NOT_ALLOWED`, `STORE_API_NOT_IN_PLAN`, `FEATURE_NOT_ENABLED` content: application/json: schema: $ref: '#/components/schemas/Error' example: success: false code: INSUFFICIENT_SCOPE error: This API key needs the orders:write permission request_id: req_7YbK2mQ9xP1cRt4v ValidationFailed: description: |- A field is missing or invalid. `details.field` names it. Codes: `VALIDATION_FAILED`, `IDEMPOTENCY_KEY_REUSED` content: application/json: schema: $ref: '#/components/schemas/Error' example: success: false code: VALIDATION_FAILED error: customer_email must be a valid email address request_id: req_7YbK2mQ9xP1cRt4v RateLimited: description: >- Too many requests. Wait `Retry-After` seconds. Codes: `RATE_LIMITED` (300 requests per minute per key), `STORE_API_MONTHLY_QUOTA_EXCEEDED` (your plan's monthly quota). headers: Retry-After: schema: type: integer description: Seconds to wait. content: application/json: schema: $ref: '#/components/schemas/Error' example: success: false code: RATE_LIMITED error: Too many requests. The limit is 300 requests per minute per key. request_id: req_7YbK2mQ9xP1cRt4v securitySchemes: ApiKey: type: apiKey in: header name: x-api-key description: >- Your Store API key (`pk_live_...`). Create it in **Developers › API keys**. StoreHash: type: apiKey in: header name: x-store-hash description: >- The ID of the store the request is for. Shown in **Developers › API keys**. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.