RCUR

Discount codes

List discount codes

get https://rcur.app/api/v2/discounts

Requires your API key as Authorization: Bearer <key>. See authentication.

Query parameters

  • page integer

    Page number for pagination

    Default: 1

Responses

200 List of discount codes object
  • data array of Discounts
    18 child attributes · Discount
    • id string required
    • code string required
    • name string nullable
    • type string required

      One of percentage fixed

    • value string required

      A percentage, or an amount in the currency of the code

    • currency string nullable

      Only for a fixed amount

    • duration string required

      How many payments of a subscription get the discount: the first, the first duration_periods, or every payment

      One of once repeating forever

    • duration_periods integer nullable
    • all_links boolean required

      Valid for every payment link, or only for the links in links

    • links array of strings

      Ids of the payment links the code is limited to

    • max_redemptions integer nullable

      How often the code can be used in total, by all customers together

    • times_redeemed integer
    • once_per_customer boolean
    • starts_at string nullable
    • expires_at string nullable
    • is_active boolean required
    • status string required

      One of active inactive scheduled expired used_up

    • created_at string required
  • links object
    4 child attributes
    • first string
    • last string
    • prev string nullable
    • next string nullable
  • meta object
    4 child attributes
    • current_page integer
    • last_page integer
    • per_page integer
    • total integer
Try it Send this request with your own API key

Requests run against the live data of the organization that owns the key.