---
title: "List checkout links"
method: GET
path: "/checkout_links"
tags: ["CheckoutLinks"]
---

# List checkout links

`GET /checkout_links`

## Request

- Base URL: `https://api.crevio.co/v1`
- URL: `https://api.crevio.co/v1/checkout_links`
- Auth: API key in header `Authorization`

Returns a list of checkout links for the current account

## Query parameters

- `expand` string
- `starting_after` string
- `limit` integer
- `metadata` object

## Response `200`

List of checkout links

- ListResponseCheckoutLink
  - `object` 'list', required
  - `data` CheckoutLink[], required
    - `id` string, required
    - `object` string, required
    - `name` string, nullable, required
    - `success_url` string, nullable, required
    - `allow_discount_codes` boolean, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `metadata` object, nullable, required
    - `url` string, required
    - `discount` union: ID by default, full object when expanded
      - string
      - Discount
        - `id` string, required
        - `object` string, required
        - `status` 'active' | 'inactive', required
        - `discount_type` 'percentage' | 'fixed', required
        - `code` string, required
        - `amount_off` integer, nullable, required
        - `duration` 'forever' | 'once' | 'repeating', required
        - `duration_in_months` integer, nullable, required
        - `max_redemptions` integer, nullable, required
        - `times_redeemed` integer, required
        - `starts_at` string, date-time, nullable, required
        - `redeem_by` string, date-time, nullable, required
        - `created_at` string, date-time, required
        - `updated_at` string, date-time, required
        - `percent_off` number, double, nullable, required
        - `currency` string, nullable, required
    - `price_variants` PriceVariant[]
      - `id` string, required
      - `object` string, required
      - `name` string, required
      - `amount` integer, nullable, required
      - `amount_type` 'free' | 'fixed' | 'custom', required
      - `billing_type` 'subscription' | 'one_time' | 'payment_plan', required
      - `recurring_interval` 'day' | 'week' | 'month' | 'year' | 'null', nullable, required
      - `interval_count` integer, required
      - `installment_count` integer, nullable, required
      - `setup_fee_amount` integer, nullable, required
      - `trial_period_days` integer, nullable, required
      - `revoke_after_days` integer, nullable, required
      - `quantity_available` integer, nullable, required
      - `archived` boolean, nullable, required
      - `position` integer, required
      - `hidden` boolean, nullable, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `currency` string, nullable, required
      - `discounted_from_amount` integer, nullable, required
      - `minimum_amount` integer, nullable, required
      - `maximum_amount` integer, nullable, required
      - `preset_amount` integer, nullable, required
      - `waitlist` boolean, required
      - `benefits` string[]
      - `purchase_url` string, required
      - `product` string, required
  - `has_more` boolean, required
  - `url` string, required

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Forbidden
- `429`: Rate limit exceeded — 600 requests per minute per credential. Retry after the number of seconds in `Retry-After`.
- `500`: Internal server error

---

[API](https://skmtc.dev/crevio/apis/crevio-api-v1.md) · [All operations](https://skmtc.dev/crevio/apis/crevio-api-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/crevio/apis/crevio-api-v1/revisions/2219f18ad651?raw)